Restrict colored_output value to always/never/auto.

cdist/argparse.py

@@ -128,10 +128,9 @@ def get_parsers():
 
     parser['colored_output'] = argparse.ArgumentParser(add_help=False)
     parser['colored_output'].add_argument(
-            '--colors',
+            '--colors', metavar='WHEN',
-            help='Use a colored output for different log levels.'
+            help="Colorize cdist's output based on log level; "
-                 'It can be a boolean or "auto" (default) which enables this '
+                 "WHEN is 'always', 'never', or 'auto'.",
-                 'feature if stdout is a tty and disables it otherwise.',
             action='store', dest='colored_output', required=False,
             choices=cdist.configuration.ColoredOutputOption.CHOICES)
 

cdist/configuration.py

@@ -248,7 +248,7 @@ class LogLevelOption(OptionBase):
 
 
 class ColoredOutputOption(BooleanOption):
-    CHOICES = tuple(configparser.ConfigParser.BOOLEAN_STATES) + ('auto',)
+    CHOICES = ('always', 'never', 'auto')
     DEFAULT = 'auto'
 
     def get_converter(self):
@@ -258,8 +258,10 @@ class ColoredOutputOption(BooleanOption):
     def translate(val):
         if isinstance(val, bool):
             return val
-        elif val in configparser.ConfigParser.BOOLEAN_STATES:
+        elif val == 'always':
-            return configparser.ConfigParser.BOOLEAN_STATES[val]
+            return True
+        elif val == 'never':
+            return False
         elif val == 'auto':
             return 'NO_COLOR' not in os.environ and sys.stdout.isatty()
 

configuration/cdist.cfg.skeleton

@@ -16,10 +16,9 @@
 # colored_output
 #     Colorize cdist's output. If enabled, cdist will use different colors for
 #     different log levels.
-#     Recognized values are 'yes'/'no', 'on'/'off', 'true'/'false', '1'/'0',
+#     Recognized values are 'always', 'never', and 'auto'.
-#     and 'auto'
+#     If the value is 'auto', colors are enabled if stdout is a TTY unless
-#     If the value is 'auto', colored output is enabled if stdout is a TTY
+#     the NO_COLOR (https://no-color.org/) environment variable is defined.
-#     unless the NO_COLOR (https://no-color.org/) environment variable is defined.
 # colored_output = auto
 #
 # conf_dir

docs/src/cdist-reference.rst.sh

@@ -369,9 +369,9 @@ CDIST_BETA
     Enable beta functionalities.
 
 CDIST_COLORED_OUTPUT
-    Use a colored output for different log levels.
+    Colorize cdist's output. If enabled, cdist will use different colors for
-    It can be a boolean or 'auto' (default) which enables this feature if
+    different log levels.
-    stdout is a tty and disables it otherwise.
+    Recognized values are 'always', 'never', and 'auto' (the default).
 
 CDIST_CACHE_PATH_PATTERN
     Custom cache path pattern.

docs/src/man1/cdist.rst

@@ -111,11 +111,11 @@ All commands accept the following options:
 **-h, --help**
     Show the help screen.
 
-**--colors COLORED_OUTPUT**
+**--colors WHEN**
     Colorize cdist's output. If enabled, cdist will use different colors for
     different log levels.
-    COLORED_OUTPUT recognizes the boolean values 'yes'/'no', 'on'/'off',
+    COLORED_OUTPUT recognizes the values 'always', 'never',
-    'true'/'false', '1'/'0', and 'auto' (the default).
+    and 'auto' (the default).
 
     If the value is 'auto', colored output is enabled if stdout is a TTY
     unless the NO_COLOR (https://no-color.org/) environment variable is defined.