python - 在点击中弃用参数别名的正确方法
问题描述
我想弃用参数别名click
(例如,从下划线切换到破折号)。有一段时间,我希望这两个公式都有效,但是FutureWarning
当使用要弃用的别名调用参数时抛出 a 。但是,我还没有找到一种方法来访问调用参数的实际别名。
简而言之,我想要:
click.command()
click.option('--old', '--new')
def cli(*args, **kwargs):
...
在使用 调用选项时发出警告--old
,但在使用 调用时不发出警告--new
。有没有一种干净的方法来做到这一点,而不是过于依赖无证行为?
我尝试向 中添加回调click.option
,但它似乎在解析选项后被调用,并且参数不包含实际使用哪个别名的信息。一个解决方案可能会超载click.Option
甚至click.Command
,但我不知道实际解析发生在哪里。
解决方案
为了能够知道用于选择特定选项的选项名称,我建议您使用一些自定义类对选项解析器进行修补。该解决方案最终继承自click.Option
and click.Command
:
代码:
import click
import warnings
class DeprecatedOption(click.Option):
def __init__(self, *args, **kwargs):
self.deprecated = kwargs.pop('deprecated', ())
self.preferred = kwargs.pop('preferred', args[0][-1])
super(DeprecatedOption, self).__init__(*args, **kwargs)
class DeprecatedOptionsCommand(click.Command):
def make_parser(self, ctx):
"""Hook 'make_parser' and during processing check the name
used to invoke the option to see if it is preferred"""
parser = super(DeprecatedOptionsCommand, self).make_parser(ctx)
# get the parser options
options = set(parser._short_opt.values())
options |= set(parser._long_opt.values())
for option in options:
if not isinstance(option.obj, DeprecatedOption):
continue
def make_process(an_option):
""" Construct a closure to the parser option processor """
orig_process = an_option.process
deprecated = getattr(an_option.obj, 'deprecated', None)
preferred = getattr(an_option.obj, 'preferred', None)
msg = "Expected `deprecated` value for `{}`"
assert deprecated is not None, msg.format(an_option.obj.name)
def process(value, state):
"""The function above us on the stack used 'opt' to
pick option from a dict, see if it is deprecated """
# reach up the stack and get 'opt'
import inspect
frame = inspect.currentframe()
try:
opt = frame.f_back.f_locals.get('opt')
finally:
del frame
if opt in deprecated:
msg = "'{}' has been deprecated, use '{}'"
warnings.warn(msg.format(opt, preferred),
FutureWarning)
return orig_process(value, state)
return process
option.process = make_process(option)
return parser
使用自定义类:
先给like加一个cls
参数@click.command
:
@click.command(cls=DeprecatedOptionsCommand)
然后对于具有弃用值的每个选项添加cls
和deprecated
值,例如:
@click.option('--old1', '--new1', cls=DeprecatedOption, deprecated=['--old1'])
并且您可以选择添加一个preferred
值,例如:
@click.option('--old2', '-x', '--new2', cls=DeprecatedOption,
deprecated=['--old2'], preferred='-x')
这是如何运作的?
这里有两个自定义类,它们派生自两个click
类。一个习惯click.Command
和click.Option
. 这是因为 click 是一个设计良好的 OO 框架。@click.command()
装饰器通常会实例化一个对象click.Command
,但允许使用cls
参数覆盖此行为。@click.option()
工作原理类似。因此,从我们自己的类中继承和覆盖所需的方法是一件相对容易的click.Command
事情click.Option
。
在自定义click.Option
:的情况下DeprecatedOption
,我们添加了两个新的关键字属性:deprecated
和preferred
. deprecated
是必需的,是将被警告的命令名称列表。preferred
是可选的,并指定推荐的命令名称。它是一个字符串,默认为选项行中的最后一个命令名称。
在自定义click.Command
:的情况下DeprecatedOptionsCommand
,我们覆盖了该make_parser()
方法。这允许我们在解析器实例中修改选项解析器实例。解析器并不是真正用于扩展的Command
,Option
所以我们必须更有创意。
在这种情况下,解析器中的所有选项处理都通过该process()
方法。在这里,我们对该方法进行猴子修补,在修补方法中,我们在堆栈帧中查找一层以查找opt
变量,该变量是用于查找选项的名称。然后,如果该值在deprecated
列表中,我们会发出警告。
此代码进入解析器中的一些私有结构,但这不太可能成为问题。该解析器代码最后一次更改是在 4 年前。解析器代码不太可能进行重大修改。
测试代码:
@click.command(cls=DeprecatedOptionsCommand)
@click.option('--old1', '--new1', cls=DeprecatedOption,
deprecated=['--old1'])
@click.option('--old2', '-x', '--new2', cls=DeprecatedOption,
deprecated=['--old2'], preferred='-x')
def cli(**kwargs):
click.echo("{}".format(kwargs))
if __name__ == "__main__":
commands = (
'--old1 5',
'--new1 6',
'--old2 7',
'--new2 8',
'-x 9',
'',
'--help',
)
import sys, time
time.sleep(1)
print('Click Version: {}'.format(click.__version__))
print('Python Version: {}'.format(sys.version))
for cmd in commands:
try:
time.sleep(0.1)
print('-----------')
print('> ' + cmd)
time.sleep(0.1)
cli(cmd.split())
except BaseException as exc:
if str(exc) != '0' and \
not isinstance(exc, (click.ClickException, SystemExit)):
raise
结果:
Click Version: 6.7
Python Version: 3.6.3 (v3.6.3:2c5fed8, Oct 3 2017, 18:11:49) [MSC v.1900 64 bit (AMD64)]
-----------
> --old1 5
{'new1': '5', 'new2': None}
C:/Users/stephen/Documents/src/testcode/test.py:71: FutureWarning: '--old1' has been deprecated, use '--new1'
FutureWarning)
-----------
> --new1 6
{'new1': '6', 'new2': None}
-----------
> --old2 7
{'new2': '7', 'new1': None}
C:/Users/stephen/Documents/src/testcode/test.py:71: FutureWarning: '--old2' has been deprecated, use '-x'
FutureWarning)
-----------
> --new2 8
{'new2': '8', 'new1': None}
-----------
> -x 9
{'new2': '9', 'new1': None}
-----------
>
{'new1': None, 'new2': None}
-----------
> --help
Usage: test.py [OPTIONS]
Options:
--old1, --new1 TEXT
-x, --old2, --new2 TEXT
--help Show this message and exit.
推荐阅读
- json - 在 IE 中将 JSON 显示为 HTML 而无需下载
- html - 我无法通过打开 HTML 文件看到我的 D3.js 设计
- sql - 多张同形桌子的ERD设计
- go - 如何临时从基础 github repo 导入到它的 fork?
- c - TCP IP 标头格式错误的数据包
- django - 我在管理站点中创建了自定义按钮并单击它转到查看 get_changeform_initial_data() 函数并在表单中放置一些静态值
- java - 如何以 JSON 格式返回信息
- codeigniter - 如何在视图解析器中访问循环项的属性?
- c# - 如何使用 AutoMapper 9.0 在 IValueResolver 中执行自定义映射
- mysql - 在 mySQL 中,我将如何测试 NOW() 是否在导致即将到来的时间戳的间隔内并且不早于时间戳?