Improve --color help with argparse metavar

asottile · asottile · commit eb6da4ae103f · 2016-03-08T16:34:09.000-08:00
diff --git a/pre_commit/color.py b/pre_commit/color.py
@@ -27,13 +27,16 @@ def format_color(text, color, use_color_setting):
         return u'{0}{1}{2}'.format(color, text, NORMAL)
 
 
+COLOR_CHOICES = ('auto', 'always', 'never')
+
+
 def use_color(setting):
     """Choose whether to use color based on the command argument.
 
     Args:
         setting - Either `auto`, `always`, or `never`
     """
-    if setting not in ('auto', 'always', 'never'):
+    if setting not in COLOR_CHOICES:
         raise InvalidColorSetting(setting)
 
     return (
diff --git a/pre_commit/main.py b/pre_commit/main.py
@@ -79,8 +79,8 @@ def main(argv=None):
     run_parser.add_argument('hook', nargs='?', help='A single hook-id to run')
     run_parser.add_argument(
         '--color', default='auto', type=color.use_color,
-        help='Whether to use color in output.  Choices are `always`, `never`'
-        ', or `auto`.  Defaults to `auto`.',
+        metavar='{' + ','.join(color.COLOR_CHOICES) + '}',
+        help='Whether to use color in output.  Defaults to `%(default)s`.',
     )
     run_parser.add_argument(
         '--no-stash', default=False, action='store_true',
@@ -91,16 +91,18 @@ def main(argv=None):
     )
     run_parser.add_argument(
         '--origin', '-o',
-        help='The origin branch\'s commit_id when using `git push`.',
+        help="The origin branch's commit_id when using `git push`.",
     )
     run_parser.add_argument(
         '--source', '-s',
-        help='The remote branch\'s commit_id when using `git push`.',
+        help="The remote branch's commit_id when using `git push`.",
     )
     run_parser.add_argument(
         '--allow-unstaged-config', default=False, action='store_true',
-        help='Allow an unstaged config to be present.  Note that this will '
-        'be stashed before parsing unless --no-stash is specified.'
+        help=(
+            'Allow an unstaged config to be present.  Note that this will '
+            'be stashed before parsing unless --no-stash is specified.'
+        ),
     )
     run_parser.add_argument(
         '--hook-stage', choices=('commit', 'push'), default='commit',
@@ -117,7 +119,7 @@ def main(argv=None):
     )
 
     help = subparsers.add_parser(
-        'help', help='Show help for a specific command.'
+        'help', help='Show help for a specific command.',
     )
     help.add_argument('help_cmd', nargs='?', help='Command to show help for.')
 

Original file line number	Diff line number	Diff line change
`@@ -79,8 +79,8 @@ def main(argv=None):`
`79`	`79`	`run_parser.add_argument('hook', nargs='?', help='A single hook-id to run')`
`80`	`80`	`run_parser.add_argument(`
`81`	`81`	`'--color', default='auto', type=color.use_color,`
`82`		- help='Whether to use color in output. Choices are `always`, `never`'
`83`		- ', or `auto`. Defaults to `auto`.',
	`82`	`+ metavar='{' + ','.join(color.COLOR_CHOICES) + '}',`
	`83`	+ help='Whether to use color in output. Defaults to `%(default)s`.',
`84`	`84`	`)`
`85`	`85`	`run_parser.add_argument(`
`86`	`86`	`'--no-stash', default=False, action='store_true',`
`@@ -91,16 +91,18 @@ def main(argv=None):`
`91`	`91`	`)`
`92`	`92`	`run_parser.add_argument(`
`93`	`93`	`'--origin', '-o',`
`94`		- help='The origin branch\'s commit_id when using `git push`.',
	`94`	+ help="The origin branch's commit_id when using `git push`.",
`95`	`95`	`)`
`96`	`96`	`run_parser.add_argument(`
`97`	`97`	`'--source', '-s',`
`98`		- help='The remote branch\'s commit_id when using `git push`.',
	`98`	+ help="The remote branch's commit_id when using `git push`.",
`99`	`99`	`)`
`100`	`100`	`run_parser.add_argument(`
`101`	`101`	`'--allow-unstaged-config', default=False, action='store_true',`
`102`		`- help='Allow an unstaged config to be present. Note that this will '`
`103`		`- 'be stashed before parsing unless --no-stash is specified.'`
	`102`	`+ help=(`
	`103`	`+ 'Allow an unstaged config to be present. Note that this will '`
	`104`	`+ 'be stashed before parsing unless --no-stash is specified.'`
	`105`	`+ ),`
`104`	`106`	`)`
`105`	`107`	`run_parser.add_argument(`
`106`	`108`	`'--hook-stage', choices=('commit', 'push'), default='commit',`
`@@ -117,7 +119,7 @@ def main(argv=None):`
`117`	`119`	`)`
`118`	`120`
`119`	`121`	`help = subparsers.add_parser(`
`120`		`- 'help', help='Show help for a specific command.'`
	`122`	`+ 'help', help='Show help for a specific command.',`
`121`	`123`	`)`
`122`	`124`	`help.add_argument('help_cmd', nargs='?', help='Command to show help for.')`
`123`	`125`