mirror of
https://github.com/python/cpython.git
synced 2025-08-31 22:18:28 +00:00
gh-133346: Make theming support in _colorize extensible (GH-133347)
Co-authored-by: Hugo van Kemenade <1324225+hugovk@users.noreply.github.com>
This commit is contained in:
Łukasz Langa
GitHub
parent
9cc77aaf9d
commit
f610bbdf74
20 changed files with 585 additions and 371 deletions
|
|
@ -176,13 +176,13 @@ class HelpFormatter(object):
|
|||
width = shutil.get_terminal_size().columns
|
||||
width -= 2
|
||||
|
||||
from _colorize import ANSIColors, NoColors, can_colorize, decolor
|
||||
from _colorize import can_colorize, decolor, get_theme
|
||||
|
||||
if color and can_colorize():
|
||||
self._ansi = ANSIColors()
|
||||
self._theme = get_theme(force_color=True).argparse
|
||||
self._decolor = decolor
|
||||
else:
|
||||
self._ansi = NoColors
|
||||
self._theme = get_theme(force_no_color=True).argparse
|
||||
self._decolor = lambda text: text
|
||||
|
||||
self._prefix_chars = prefix_chars
|
||||
|
|
@ -237,14 +237,12 @@ class HelpFormatter(object):
|
|||
|
||||
# add the heading if the section was non-empty
|
||||
if self.heading is not SUPPRESS and self.heading is not None:
|
||||
bold_blue = self.formatter._ansi.BOLD_BLUE
|
||||
reset = self.formatter._ansi.RESET
|
||||
|
||||
current_indent = self.formatter._current_indent
|
||||
heading_text = _('%(heading)s:') % dict(heading=self.heading)
|
||||
t = self.formatter._theme
|
||||
heading = (
|
||||
f'{" " * current_indent}'
|
||||
f'{bold_blue}{heading_text}{reset}\n'
|
||||
f'{t.heading}{heading_text}{t.reset}\n'
|
||||
)
|
||||
else:
|
||||
heading = ''
|
||||
|
|
@ -314,10 +312,7 @@ class HelpFormatter(object):
|
|||
if part and part is not SUPPRESS])
|
||||
|
||||
def _format_usage(self, usage, actions, groups, prefix):
|
||||
bold_blue = self._ansi.BOLD_BLUE
|
||||
bold_magenta = self._ansi.BOLD_MAGENTA
|
||||
magenta = self._ansi.MAGENTA
|
||||
reset = self._ansi.RESET
|
||||
t = self._theme
|
||||
|
||||
if prefix is None:
|
||||
prefix = _('usage: ')
|
||||
|
|
@ -325,15 +320,15 @@ class HelpFormatter(object):
|
|||
# if usage is specified, use that
|
||||
if usage is not None:
|
||||
usage = (
|
||||
magenta
|
||||
t.prog_extra
|
||||
+ usage
|
||||
% {"prog": f"{bold_magenta}{self._prog}{reset}{magenta}"}
|
||||
+ reset
|
||||
% {"prog": f"{t.prog}{self._prog}{t.reset}{t.prog_extra}"}
|
||||
+ t.reset
|
||||
)
|
||||
|
||||
# if no optionals or positionals are available, usage is just prog
|
||||
elif usage is None and not actions:
|
||||
usage = f"{bold_magenta}{self._prog}{reset}"
|
||||
usage = f"{t.prog}{self._prog}{t.reset}"
|
||||
|
||||
# if optionals and positionals are available, calculate usage
|
||||
elif usage is None:
|
||||
|
|
@ -411,10 +406,10 @@ class HelpFormatter(object):
|
|||
usage = '\n'.join(lines)
|
||||
|
||||
usage = usage.removeprefix(prog)
|
||||
usage = f"{bold_magenta}{prog}{reset}{usage}"
|
||||
usage = f"{t.prog}{prog}{t.reset}{usage}"
|
||||
|
||||
# prefix with 'usage:'
|
||||
return f'{bold_blue}{prefix}{reset}{usage}\n\n'
|
||||
return f'{t.usage}{prefix}{t.reset}{usage}\n\n'
|
||||
|
||||
def _format_actions_usage(self, actions, groups):
|
||||
return ' '.join(self._get_actions_usage_parts(actions, groups))
|
||||
|
|
@ -452,10 +447,7 @@ class HelpFormatter(object):
|
|||
|
||||
# collect all actions format strings
|
||||
parts = []
|
||||
cyan = self._ansi.CYAN
|
||||
green = self._ansi.GREEN
|
||||
yellow = self._ansi.YELLOW
|
||||
reset = self._ansi.RESET
|
||||
t = self._theme
|
||||
for action in actions:
|
||||
|
||||
# suppressed arguments are marked with None
|
||||
|
|
@ -465,7 +457,11 @@ class HelpFormatter(object):
|
|||
# produce all arg strings
|
||||
elif not action.option_strings:
|
||||
default = self._get_default_metavar_for_positional(action)
|
||||
part = green + self._format_args(action, default) + reset
|
||||
part = (
|
||||
t.summary_action
|
||||
+ self._format_args(action, default)
|
||||
+ t.reset
|
||||
)
|
||||
|
||||
# if it's in a group, strip the outer []
|
||||
if action in group_actions:
|
||||
|
|
@ -481,9 +477,9 @@ class HelpFormatter(object):
|
|||
if action.nargs == 0:
|
||||
part = action.format_usage()
|
||||
if self._is_long_option(part):
|
||||
part = f"{cyan}{part}{reset}"
|
||||
part = f"{t.summary_long_option}{part}{t.reset}"
|
||||
elif self._is_short_option(part):
|
||||
part = f"{green}{part}{reset}"
|
||||
part = f"{t.summary_short_option}{part}{t.reset}"
|
||||
|
||||
# if the Optional takes a value, format is:
|
||||
# -s ARGS or --long ARGS
|
||||
|
|
@ -491,10 +487,13 @@ class HelpFormatter(object):
|
|||
default = self._get_default_metavar_for_optional(action)
|
||||
args_string = self._format_args(action, default)
|
||||
if self._is_long_option(option_string):
|
||||
option_string = f"{cyan}{option_string}"
|
||||
option_color = t.summary_long_option
|
||||
elif self._is_short_option(option_string):
|
||||
option_string = f"{green}{option_string}"
|
||||
part = f"{option_string} {yellow}{args_string}{reset}"
|
||||
option_color = t.summary_short_option
|
||||
part = (
|
||||
f"{option_color}{option_string} "
|
||||
f"{t.summary_label}{args_string}{t.reset}"
|
||||
)
|
||||
|
||||
# make it look optional if it's not required or in a group
|
||||
if not action.required and action not in group_actions:
|
||||
|
|
@ -590,17 +589,14 @@ class HelpFormatter(object):
|
|||
return self._join_parts(parts)
|
||||
|
||||
def _format_action_invocation(self, action):
|
||||
bold_green = self._ansi.BOLD_GREEN
|
||||
bold_cyan = self._ansi.BOLD_CYAN
|
||||
bold_yellow = self._ansi.BOLD_YELLOW
|
||||
reset = self._ansi.RESET
|
||||
t = self._theme
|
||||
|
||||
if not action.option_strings:
|
||||
default = self._get_default_metavar_for_positional(action)
|
||||
return (
|
||||
bold_green
|
||||
t.action
|
||||
+ ' '.join(self._metavar_formatter(action, default)(1))
|
||||
+ reset
|
||||
+ t.reset
|
||||
)
|
||||
|
||||
else:
|
||||
|
|
@ -609,9 +605,9 @@ class HelpFormatter(object):
|
|||
parts = []
|
||||
for s in strings:
|
||||
if self._is_long_option(s):
|
||||
parts.append(f"{bold_cyan}{s}{reset}")
|
||||
parts.append(f"{t.long_option}{s}{t.reset}")
|
||||
elif self._is_short_option(s):
|
||||
parts.append(f"{bold_green}{s}{reset}")
|
||||
parts.append(f"{t.short_option}{s}{t.reset}")
|
||||
else:
|
||||
parts.append(s)
|
||||
return parts
|
||||
|
|
@ -628,7 +624,7 @@ class HelpFormatter(object):
|
|||
default = self._get_default_metavar_for_optional(action)
|
||||
option_strings = color_option_strings(action.option_strings)
|
||||
args_string = (
|
||||
f"{bold_yellow}{self._format_args(action, default)}{reset}"
|
||||
f"{t.label}{self._format_args(action, default)}{t.reset}"
|
||||
)
|
||||
return ', '.join(option_strings) + ' ' + args_string
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue