Made constants for color values

Author: kmvanbrunt

cmd2/argparse_completer.py

@@ -66,7 +66,7 @@ def my_completer(text: str, line: str, begidx: int, endidx:int, extra_param: str
 from argparse import ZERO_OR_MORE, ONE_OR_MORE, ArgumentError, _, _get_action_name, SUPPRESS
 from typing import List, Dict, Tuple, Callable, Union
 
-from colorama import Fore
+from . import constants
 
 from .rl_utils import rl_force_redisplay
 from .utils import ansi_safe_wcswidth
@@ -996,7 +996,7 @@ def error(self, message: str) -> None:
             linum += 1
 
         self.print_usage(sys.stderr)
-        self.exit(2, Fore.LIGHTRED_EX + '{}\n\n'.format(formatted_message) + Fore.RESET)
+        self.exit(2, constants.ERROR_COLOR + '{}\n\n'.format(formatted_message) + constants.RESET_COLOR)
 
     def format_help(self) -> str:
         """Copy of format_help() from argparse.ArgumentParser with tweaks to separately display required parameters"""

cmd2/cmd2.py

@@ -42,7 +42,6 @@
 from typing import Any, Callable, Dict, List, Mapping, Optional, Tuple, Type, Union, IO
 
 import colorama
-from colorama import Fore
 
 from . import constants
 from . import plugin
@@ -59,7 +58,7 @@
     rl_warning = "Readline features including tab completion have been disabled since no \n" \
                  "supported version of readline was found. To resolve this, install \n" \
                  "pyreadline on Windows or gnureadline on Mac.\n\n"
-    sys.stderr.write(Fore.LIGHTYELLOW_EX + rl_warning + Fore.RESET)
+    sys.stderr.write(constants.WARNING_COLOR + rl_warning + constants.RESET_COLOR)
 else:
     from .rl_utils import rl_force_redisplay, readline
 
@@ -616,7 +615,7 @@ def poutput(self, msg: Any, end: str = '\n', color: str = '') -> None:
                 if not msg_str.endswith(end):
                     msg_str += end
                 if color:
-                    msg_str = color + msg_str + Fore.RESET
+                    msg_str = color + msg_str + constants.RESET_COLOR
                 self.decolorized_write(self.stdout, msg_str)
             except BrokenPipeError:
                 # This occurs if a command's output is being piped to another
@@ -627,8 +626,8 @@ def poutput(self, msg: Any, end: str = '\n', color: str = '') -> None:
                 if self.broken_pipe_warning:
                     sys.stderr.write(self.broken_pipe_warning)
 
-    def perror(self, err: Union[str, Exception], traceback_war: bool = True, err_color: str = Fore.LIGHTRED_EX,
-               war_color: str = Fore.LIGHTYELLOW_EX) -> None:
+    def perror(self, err: Union[str, Exception], traceback_war: bool = True, err_color: str = constants.ERROR_COLOR,
+               war_color: str = constants.WARNING_COLOR) -> None:
         """ Print error message to sys.stderr and if debug is true, print an exception Traceback if one exists.
 
         :param err: an Exception or error message to print out
@@ -644,12 +643,12 @@ def perror(self, err: Union[str, Exception], traceback_war: bool = True, err_col
             err_msg = "EXCEPTION of type '{}' occurred with message: '{}'\n".format(type(err).__name__, err)
         else:
             err_msg = "{}\n".format(err)
-        err_msg = err_color + err_msg + Fore.RESET
+        err_msg = err_color + err_msg + constants.RESET_COLOR
         self.decolorized_write(sys.stderr, err_msg)
 
         if traceback_war and not self.debug:
             war = "To enable full traceback, run the following command:  'set debug true'\n"
-            war = war_color + war + Fore.RESET
+            war = war_color + war + constants.RESET_COLOR
             self.decolorized_write(sys.stderr, war)
 
     def pfeedback(self, msg: str) -> None:
@@ -3745,7 +3744,7 @@ class TestMyAppCase(Cmd2TestCase):
         test_results = runner.run(testcase)
         if test_results.wasSuccessful():
             self.decolorized_write(sys.stderr, stream.read())
-            self.poutput('Tests passed', color=Fore.LIGHTGREEN_EX)
+            self.poutput('Tests passed', color=constants.SUCCESS_COLOR)
         else:
             # Strip off the initial traceback which isn't particularly useful for end users
             error_str = stream.read()

cmd2/constants.py

@@ -3,6 +3,7 @@
 """Constants and definitions"""
 
 import re
+from colorama import Fore
 
 # Used for command parsing, output redirection, tab completion and word
 # breaks. Do not change.
@@ -20,7 +21,13 @@
 
 LINE_FEED = '\n'
 
-# values for colors setting
+# Values for colors setting
 COLORS_NEVER = 'Never'
 COLORS_TERMINAL = 'Terminal'
 COLORS_ALWAYS = 'Always'
+
+# Text colors
+SUCCESS_COLOR = Fore.LIGHTGREEN_EX
+WARNING_COLOR = Fore.LIGHTYELLOW_EX
+ERROR_COLOR = Fore.LIGHTRED_EX
+RESET_COLOR = Fore.RESET