1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
|
######################################################################
#
# File: b2/_internal/arg_parser.py
#
# Copyright 2020 Backblaze Inc. All Rights Reserved.
#
# License https://www.backblaze.com/using_b2_code.html
#
######################################################################
from __future__ import annotations
import argparse
import functools
import locale
import re
import sys
import textwrap
import unittest.mock
from rst2ansi import rst2ansi
class B2RawTextHelpFormatter(argparse.RawTextHelpFormatter):
"""
CLI custom formatter.
It removes default "usage: " text and prints usage for all (non-hidden) subcommands.
"""
def __init__(self, *args, show_all: bool = False, **kwargs):
super().__init__(*args, **kwargs)
self.show_all = show_all
def add_usage(self, usage, actions, groups, prefix=None):
if prefix is None:
prefix = ''
super().add_usage(usage, actions, groups, prefix)
def add_argument(self, action):
if isinstance(action, argparse._SubParsersAction) and action.help is not argparse.SUPPRESS:
usages = []
for choice in self._unique_choice_values(action):
deprecated = getattr(choice, 'deprecated', False)
if deprecated:
if self.show_all:
usages.append(f'(DEPRECATED) {choice.format_usage()}')
else:
usages.append(choice.format_usage())
self.add_text(''.join(usages))
else:
super().add_argument(action)
@classmethod
def _unique_choice_values(cls, action):
seen = set()
seen_add = seen.add
for value in action.choices.values():
if not (value in seen or seen_add(value)):
yield value
class _HelpAllAction(argparse._HelpAction):
"""Like argparse._HelpAction but prints help for all subcommands (even deprecated ones)."""
def __call__(self, parser, namespace, values, option_string=None):
parser.print_help(show_all=True)
parser.exit()
class B2ArgumentParser(argparse.ArgumentParser):
"""
CLI custom parser.
It fixes indentation of the description, set the custom formatter as a default
and use help message in case of error.
"""
def __init__(
self,
*args,
add_help_all: bool = True,
for_docs: bool = False,
deprecated: bool = False,
**kwargs
):
"""
:param for_docs: is this parser used for generating docs
:param deprecated: is this option deprecated
"""
self._raw_description = None
self._description = None
self._for_docs = for_docs
self.deprecated = deprecated
kwargs.setdefault('formatter_class', B2RawTextHelpFormatter)
super().__init__(*args, **kwargs)
if add_help_all:
self.register('action', 'help_all', _HelpAllAction)
self.add_argument(
'--help-all',
help='show help for all options, including deprecated ones',
action='help_all',
)
@property
def description(self):
if self._description is None and self._raw_description is not None:
if self._for_docs:
self._description = textwrap.dedent(self._raw_description)
else:
encoding = self._get_encoding()
self._description = rst2ansi(
self._raw_description.encode(encoding), output_encoding=encoding
)
return self._description
@description.setter
def description(self, value):
self._raw_description = value
def error(self, message):
self.print_help()
self.exit(2, f'\n{self.prog}: error: {message}\n')
@classmethod
def _get_encoding(cls):
_, locale_encoding = locale.getdefaultlocale()
# Check if the stdout is properly set
if sys.stdout.encoding is not None:
# Use the stdout encoding
return sys.stdout.encoding
# Fall back to the locale_encoding if stdout encoding is not set
elif locale_encoding is not None:
return locale_encoding
# locales are improperly configured
return 'ascii'
def print_help(self, *args, show_all: bool = False, **kwargs):
"""
Print help message.
"""
with unittest.mock.patch.object(
self, 'formatter_class', functools.partial(B2RawTextHelpFormatter, show_all=show_all)
):
super().print_help(*args, **kwargs)
SUPPORT_CAMEL_CASE_ARGUMENTS = False
def enable_camel_case_arguments():
global SUPPORT_CAMEL_CASE_ARGUMENTS
SUPPORT_CAMEL_CASE_ARGUMENTS = True
def make_deprecated_action_call(action):
def deprecated_action_call(self, parser, namespace, values, option_string=None, **kwargs):
action.__call__(self, parser, namespace, values, option_string, **kwargs)
if option_string:
kebab_option_string = _camel_to_kebab(option_string)
print(
f"The '{option_string}' argument is deprecated. Use '{kebab_option_string}' instead.",
file=sys.stderr
)
return deprecated_action_call
_kebab_to_snake_pattern = re.compile(r'-')
_camel_to_kebab_pattern = re.compile(r'(?<=[a-z])([A-Z])')
_kebab_to_camel_pattern = re.compile(r'-(\w)')
def _camel_to_kebab(s: str):
return _camel_to_kebab_pattern.sub(r'-\1', s).lower()
def _kebab_to_camel(s: str):
return "--" + _kebab_to_camel_pattern.sub(lambda m: m.group(1).upper(), s[2:])
def _kebab_to_snake(s: str):
return _kebab_to_snake_pattern.sub('_', s)
class DeprecatedActionMarker:
pass
def add_normalized_argument(parser, param_name, *args, **kwargs):
param_name_kebab = _camel_to_kebab(param_name)
param_name_camel = _kebab_to_camel(param_name_kebab)
dest_name_snake = _kebab_to_snake(param_name_kebab)[2:]
kwargs_kebab = dict(kwargs)
kwargs_camel = kwargs
kwargs_camel['help'] = argparse.SUPPRESS
if 'dest' not in kwargs_kebab:
kwargs_kebab['dest'] = dest_name_snake
kwargs_camel['dest'] = dest_name_snake
if 'action' in kwargs:
if isinstance(kwargs['action'], str):
action = parser._registry_get('action', kwargs['action'])
else:
action = kwargs['action']
else:
action = argparse._StoreAction
kwargs_camel['action'] = type(
'DeprecatedAction', (action, DeprecatedActionMarker),
{'__call__': make_deprecated_action_call(action)}
)
parser.add_argument(f'{param_name_kebab}', *args, **kwargs_kebab)
if SUPPORT_CAMEL_CASE_ARGUMENTS and param_name_kebab != param_name_camel:
parser.add_argument(f'{param_name_camel}', *args, **kwargs_camel)
|