Colorize live-log levelnames #3142

twmr · 2018-01-23T00:06:38Z

I propose to prettify the default output of the live logs a bit by colorizing the levelnames.

A screenshot paints a thousand words:

coveralls · 2018-01-23T01:26:46Z

Coverage decreased (-0.02%) to 92.628% when pulling ebab1b6 on thisch:only_colorize_levelname into 49773b5 on pytest-dev:features.

twmr · 2018-01-26T18:32:05Z

What do you think about this?

Are there tests that test the text colors of the pytest output, where I can take a look at?

nicoddemus · 2018-01-26T18:34:57Z

Are there tests that test the text colors of the pytest output, where I can take a look at?

Unfortunately no AFAIK. 😕

twmr · 2018-01-26T19:10:56Z

Note that I successfully tested this PR in cpython2.7 and in cpython3.6.

nicoddemus · 2018-01-27T13:08:22Z

This is how it looks on Windows:

👍

nicoddemus

This looks great @Thisch, please take a look at my comments! 👍

nicoddemus · 2018-01-27T13:10:30Z

_pytest/logging.py

 DEFAULT_LOG_FORMAT = '%(filename)-25s %(lineno)4d %(levelname)-8s %(message)s'
 DEFAULT_LOG_DATE_FORMAT = '%H:%M:%S'

+# move to __init__ of ColoredLevelFormatter?
+LEVELNAME_FMT_REGEX = re.compile(r'%\(levelname\)([+-]?\d*s)')


Probably both LEVELNAME_FMT_REGEX and LOGLEVEL_COLOROPTS would be better off being class attributes of ColoredLevelFormatter.

nicoddemus · 2018-01-27T13:10:55Z

_pytest/logging.py

+    def __init__(self, *args, **kwargs):
+        super(ColoredLevelFormatter, self).__init__(
+            *args, **kwargs)
+        if py.std.sys.version_info[0] >= 3:


Please use six.PY3 instead (this will make it easier later to find python2-specific code)

nicoddemus · 2018-01-27T13:13:48Z

_pytest/logging.py

+        fmt = self._level_to_fmt_mapping.get(
+            record.levelno, self._original_fmt)
+
+        if py.std.sys.version_info[0] >= 3:


Ditto here for six.PY3 👍

nicoddemus · 2018-01-27T13:15:59Z

_pytest/logging.py

+LEVELNAME_FMT_REGEX = re.compile(r'%\(levelname\)([+-]?\d*s)')
+
+
+class ColoredLevelFormatter(logging.Formatter):


To test this, probably the way to go is to unittest the ColoredLevelFormatter class directly: create an instance and pass different LogRecord instances and ensure they have the correct markup applied. Also interesting to use custom log levels and ensure they don't have any markup.

Unfortunately this does not work, since tw.markup() does not add ANSI escape sequences around the string in the unit tests:

(Pdb++) tw.markup('abc', red=True) 'abc' (Pdb++) tw.hasmarkup False

Any ideas?

I'll do some mocking and then it should work.

ping @nicoddemus

twmr · 2018-01-30T12:34:28Z

I guess that this is already too late for pytest 3.4, right?

twmr · 2018-01-30T12:35:52Z

BTW, I don't understand why the tests fail.

nicoddemus · 2018-01-30T12:50:28Z

I guess that this is already too late for pytest 3.4, right?

I plan to release 3.4 when I get home later, but if we merge this until then I will be happy to generate the package again.

BTW, I don't understand why the tests fail.

No idea either, seems to be some bad interaction with mock... I suggest to try to use monkeypatch in your test instead of mock to see if the problem goes away (plus it will work on Python 2 as well).

twmr · 2018-01-30T15:26:27Z

Let's hope that the tests now pass.

nicoddemus · 2018-01-30T15:35:18Z

Just remembered this now and would like to confirm, passing --color=no disables the colors?

twmr · 2018-01-30T15:59:55Z

Now the color config option should be taken into account. This made the monkeypatching code obsolete.

twmr · 2018-01-30T16:02:06Z

_pytest/logging.py

@@ -376,7 +432,10 @@ def _setup_cli_logging(self):
            log_cli_handler = _LiveLoggingStreamHandler(terminal_reporter, capture_manager)
            log_cli_format = get_option_ini(self._config, 'log_cli_format', 'log_format')
            log_cli_date_format = get_option_ini(self._config, 'log_cli_date_format', 'log_date_format')
-            log_cli_formatter = logging.Formatter(log_cli_format, datefmt=log_cli_date_format)
+            if ColoredLevelFormatter.LEVELNAME_FMT_REGEX.search(log_cli_format):
+                log_cli_formatter = ColoredLevelFormatter(self._config, log_cli_format, datefmt=log_cli_date_format)


I could also perform the color check in the condition in line 435. Then I don't need to pass self._config to the __init__ method of ColoredLevelFormatter.

Seems better

I didn't know that color is a ternary type ('yes', 'no' and 'auto'). So I can't add self._config.option.color == 'yes' and to the if condition. If the value of the color option is 'auto' the TerminalWriter.init determines if the terminal supports markup or not.

An alternative would be to pass a terminalwriter object (_pytest.config.create_terminal_writer(self._config)) as the first arg of ColoredLevelFormatter. Don't know if this makes it better.

An alternative would be to pass a terminalwriter object (_pytest.config.create_terminal_writer(self._config)) as the first arg of ColoredLevelFormatter. Don't know if this makes it better.

This reduces the number of dependencies at least (ColoredLevelFormatter will then depend only on TerminalWriter, instead of Config and TerminalWriter with the current code), so feel free to go with this route.

twmr · 2018-01-30T17:58:08Z

If all tests pass, this is ready for merging.

nicoddemus · 2018-01-30T19:53:41Z

Thanks @Thisch!

twmr changed the base branch from master to features January 23, 2018 00:27

twmr force-pushed the only_colorize_levelname branch from c7d729c to 216b21a Compare January 23, 2018 00:32

twmr force-pushed the only_colorize_levelname branch 2 times, most recently from 87013c4 to d797e3f Compare January 26, 2018 11:08

twmr changed the title ~~WIP: Colorize live-log levelnames~~ Colorize live-log levelnames Jan 26, 2018

twmr force-pushed the only_colorize_levelname branch from d797e3f to ed1051f Compare January 26, 2018 11:31

nicoddemus requested changes Jan 27, 2018

View reviewed changes

twmr force-pushed the only_colorize_levelname branch from ed1051f to c1da614 Compare January 27, 2018 19:41

twmr force-pushed the only_colorize_levelname branch from c1da614 to 6c0a8ac Compare January 30, 2018 15:25

twmr force-pushed the only_colorize_levelname branch from 6c0a8ac to 1ad52b9 Compare January 30, 2018 15:58

twmr commented Jan 30, 2018

View reviewed changes

live-logging: Colorize levelname

ebab1b6

twmr force-pushed the only_colorize_levelname branch from 1ad52b9 to ebab1b6 Compare January 30, 2018 17:21

nicoddemus approved these changes Jan 30, 2018

View reviewed changes

nicoddemus merged commit 71a7b3c into pytest-dev:features Jan 30, 2018

nicoddemus mentioned this pull request Jan 30, 2018

Release 3.4.0 #3162

Merged

twmr mentioned this pull request Feb 17, 2018

Print captured logs before entering pdb #3204

Closed

twmr deleted the only_colorize_levelname branch February 23, 2018 16:30

BeyondEvil mentioned this pull request Jul 15, 2020

Garbage date-time is printed in the Captured log. pytest-dev/pytest-html#314

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Colorize live-log levelnames #3142

Colorize live-log levelnames #3142

twmr commented Jan 23, 2018 •

edited

Loading

coveralls commented Jan 23, 2018 •

edited

Loading

twmr commented Jan 26, 2018

nicoddemus commented Jan 26, 2018

twmr commented Jan 26, 2018

nicoddemus commented Jan 27, 2018

nicoddemus left a comment

nicoddemus Jan 27, 2018

nicoddemus Jan 27, 2018

nicoddemus Jan 27, 2018

nicoddemus Jan 27, 2018

twmr Jan 27, 2018 •

edited

Loading

twmr Jan 27, 2018

twmr Jan 30, 2018

twmr commented Jan 30, 2018

twmr commented Jan 30, 2018

nicoddemus commented Jan 30, 2018

twmr commented Jan 30, 2018

nicoddemus commented Jan 30, 2018

twmr commented Jan 30, 2018

twmr Jan 30, 2018

nicoddemus Jan 30, 2018

twmr Jan 30, 2018

nicoddemus Jan 30, 2018

twmr commented Jan 30, 2018

nicoddemus commented Jan 30, 2018

		LEVELNAME_FMT_REGEX = re.compile(r'%\(levelname\)([+-]?\d*s)')


		class ColoredLevelFormatter(logging.Formatter):

Colorize live-log levelnames #3142

Colorize live-log levelnames #3142

Conversation

twmr commented Jan 23, 2018 • edited Loading

coveralls commented Jan 23, 2018 • edited Loading

twmr commented Jan 26, 2018

nicoddemus commented Jan 26, 2018

twmr commented Jan 26, 2018

nicoddemus commented Jan 27, 2018

nicoddemus left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

twmr Jan 27, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

twmr commented Jan 30, 2018

twmr commented Jan 30, 2018

nicoddemus commented Jan 30, 2018

twmr commented Jan 30, 2018

nicoddemus commented Jan 30, 2018

twmr commented Jan 30, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

twmr commented Jan 30, 2018

nicoddemus commented Jan 30, 2018

twmr commented Jan 23, 2018 •

edited

Loading

coveralls commented Jan 23, 2018 •

edited

Loading

twmr Jan 27, 2018 •

edited

Loading