From 31e08c947540b1b8c7e83f050509b29812e2b2fd Mon Sep 17 00:00:00 2001 From: Ethan Paul <24588726+enpaul@users.noreply.github.com> Date: Fri, 16 Apr 2021 20:08:26 -0400 Subject: [PATCH] Add internal logging wrapper to reduce copy/paste --- tox_poetry_installer/logger.py | 29 +++++++++++++++++++++++++++++ 1 file changed, 29 insertions(+) create mode 100644 tox_poetry_installer/logger.py diff --git a/tox_poetry_installer/logger.py b/tox_poetry_installer/logger.py new file mode 100644 index 0000000..11bee82 --- /dev/null +++ b/tox_poetry_installer/logger.py @@ -0,0 +1,29 @@ +"""Logging wrappers to reduce duplication elsewhere + +Calling ``tox.reporter.something()`` and having to format a string with the prefix +gets really old fast, but more importantly it also makes the flow of the main code +more difficult to follow because of the added complexity. +""" +import tox + +from tox_poetry_installer import constants + + +def error(message: str): + """Wrapper around :func:`tox.reporter.error`""" + tox.reporter.error(f"{constants.REPORTER_PREFIX} {message}") + + +def warning(message: str): + """Wrapper around :func:`tox.reporter.warning`""" + tox.reporter.warning(f"{constants.REPORTER_PREFIX} {message}") + + +def info(message: str): + """Wrapper around :func:`tox.reporter.verbosity1`""" + tox.reporter.verbosity1(f"{constants.REPORTER_PREFIX} {message}") + + +def debug(message: str): + """Wrapper around :func:`tox.reporter.verbosity2`""" + tox.reporter.verbosity2(f"{constants.REPORTER_PREFIX} {message}")