tools: Move message formatting functions to a new file

Author: Jakub Klimczak

protoplaster/api/v1/execution.py

@@ -1,6 +1,6 @@
 from flask import Blueprint, jsonify, request
 import importlib
-from protoplaster.tools.tools import error
+from protoplaster.tools.log import error
 
 execution_blueprint: Blueprint = Blueprint("protoplaster-execution", __name__)
 

protoplaster/conf/parser.py

@@ -7,7 +7,7 @@
 import yaml
 
 import protoplaster.tests
-from protoplaster.tools.tools import pr_err, pr_info, pr_warn
+from protoplaster.tools.log import pr_err, pr_info, pr_warn
 
 StrPath = str | Path
 

protoplaster/conf/plugin_manager.py

@@ -3,7 +3,7 @@
 import importlib
 
 from protoplaster.conf.consts import PROTOPLASTER
-from protoplaster.tools.tools import pr_warn, pr_info
+from protoplaster.tools.log import pr_warn, pr_info
 
 hookspec = HookspecMarker(PROTOPLASTER)
 hookimpl = HookimplMarker(PROTOPLASTER)

protoplaster/protoplaster.py

@@ -17,7 +17,7 @@
 from protoplaster.runner.manager import RunManager
 from protoplaster.runner.runner import list_tests, list_test_suites, run_tests
 from protoplaster.report_generators.system_report.protoplaster_system_report import __file__ as system_report_file
-from protoplaster.tools.tools import error, info
+from protoplaster.tools.log import error, info
 
 
 def create_docs_app() -> Flask:

protoplaster/runner/runner.py

@@ -21,7 +21,7 @@
 from protoplaster.conf.parser import TestFile, load_yaml
 from protoplaster.report_generators.test_report.protoplaster_test_report import generate_test_report
 from protoplaster.report_generators.system_report.protoplaster_system_report import generate_system_report, CommandConfig, run_command
-from protoplaster.tools.tools import error, pr_warn, pr_err, warning
+from protoplaster.tools.log import error, pr_warn, pr_err, warning
 from protoplaster.webui.devices import get_all_devices
 from protoplaster.conf.consts import REMOTE_RUN_TRIGGER_TIMEOUT, SERVE_IP, WEBUI_POLLING_INTERVAL, LOCAL_DEVICE_HOST
 from protoplaster import __file__ as protoplaster_root

protoplaster/tools/log.py

@@ -0,0 +1,25 @@
+from colorama import Fore, Style
+
+
+def warning(text):
+    return Fore.YELLOW + f"[WARNING] {text}" + Style.RESET_ALL
+
+
+def pr_warn(text):
+    print(warning(text))
+
+
+def error(text):
+    return Fore.RED + f"[ERROR] {text}" + Style.RESET_ALL
+
+
+def pr_err(text):
+    print(error(text))
+
+
+def info(text):
+    return f"[INFO] {text}"
+
+
+def pr_info(text):
+    print(info(text))

protoplaster/tools/tools.py

@@ -1,5 +1,4 @@
 import requests
-from colorama import Fore, Style
 from typing import Callable, Optional, List, Any, Union
 from concurrent.futures import ThreadPoolExecutor, Future
 
@@ -20,30 +19,6 @@ def assert_user_input(user_message,
         assert answer.lower() == possible_answers[correct_answer].lower()
 
 
-def warning(text):
-    return Fore.YELLOW + f"[WARNING] {text}" + Style.RESET_ALL
-
-
-def pr_warn(text):
-    print(warning(text))
-
-
-def error(text):
-    return Fore.RED + f"[ERROR] {text}" + Style.RESET_ALL
-
-
-def pr_err(text):
-    print(error(text))
-
-
-def info(text):
-    return f"[INFO] {text}"
-
-
-def pr_info(text):
-    print(info(text))
-
-
 def _execute_request(url: str, method: Callable, args: List[Any]) -> Any:
     payload = {
         "module": method.__module__,

protoplaster/webui/views.py

@@ -3,7 +3,7 @@
 import requests
 from protoplaster.webui.devices import get_all_devices, get_device_by_name, add_device, remove_device
 from protoplaster.conf.consts import WEBUI_POLLING_INTERVAL
-from protoplaster.tools.tools import error
+from protoplaster.tools.log import error
 
 
 @webui_blueprint.route("/")