Это можно сделать, создав собственный класс, производный от click.Option
, и в этом классе переопределить метод click.Option.handle_parse_result()
, например:
Пользовательский класс:
import click
class NotRequiredIf(click.Option):
def __init__(self, *args, **kwargs):
self.not_required_if = kwargs.pop('not_required_if')
assert self.not_required_if, "'not_required_if' parameter required"
kwargs['help'] = (kwargs.get('help', '') +
' NOTE: This argument is mutually exclusive with %s' %
self.not_required_if
).strip()
super(NotRequiredIf, self).__init__(*args, **kwargs)
def handle_parse_result(self, ctx, opts, args):
we_are_present = self.name in opts
other_present = self.not_required_if in opts
if other_present:
if we_are_present:
raise click.UsageError(
"Illegal usage: `%s` is mutually exclusive with `%s`" % (
self.name, self.not_required_if))
else:
self.prompt = None
return super(NotRequiredIf, self).handle_parse_result(
ctx, opts, args)
Использование пользовательского класса:
Чтобы использовать пользовательский класс, передайте параметр cls
декоратору click.option
, например:
@click.option('--username', prompt=True, cls=NotRequiredIf,
not_required_if='authentication_token')
Как это работает?
Это работает, потому что click — это хорошо спроектированная объектно-ориентированная среда. Декоратор @click.option()
обычно создает экземпляр объекта click.Option
, но позволяет переопределить это поведение с помощью параметра cls
. Таким образом, относительно легко наследоваться от click.Option
в нашем собственном классе и переопределять нужные методы.
В этом случае мы игнорируем click.Option.handle_parse_result()
и отключаем необходимость user/password
, если присутствует токен authentication-token
, и жалуемся, если присутствуют оба user/password
и authentication-token
.
Примечание. Этот ответ был вдохновлен этим ответом
Тестовый код:
@click.command()
@click.option('--authentication-token')
@click.option('--username', prompt=True, cls=NotRequiredIf,
not_required_if='authentication_token')
@click.option('--password', prompt=True, hide_input=True, cls=NotRequiredIf,
not_required_if='authentication_token')
def login(authentication_token, username, password):
click.echo('t:%s u:%s p:%s' % (
authentication_token, username, password))
if __name__ == '__main__':
login('--username name --password pword'.split())
login('--help'.split())
login(''.split())
login('--username name'.split())
login('--authentication-token token'.split())
Результаты:
от login('--username name --password pword'.split())
:
t:None u:name p:pword
от login('--help'.split())
:
Usage: test.py [OPTIONS]
Options:
--authentication-token TEXT
--username TEXT NOTE: This argument is mutually exclusive with
authentication_token
--password TEXT NOTE: This argument is mutually exclusive with
authentication_token
--help Show this message and exit.
person
Stephen Rauch
schedule
03.06.2017