Carregue em Interfaces da linha de comandos: faça as opções necessárias se outra opção opcional estiver desactivada

ao escrever uma interface de linha de comandos (CLI) com a Biblioteca click, é possível definir, por exemplo, Três opções onde a segunda e a terceira só são necessárias se a primeira (opcional) ficou desactivada?

o meu caso de utilização é um sistema de registo que me permite autenticar quer através de um authentication token (Opção 1), quer, em alternativa, através de username (Opção 2) e password (Opção 3).

Se a ficha foi dada, não há necessidade de verificar se username e password são definido ou incitando-os. Caso contrário, se o token foi omitido então username e password tornar-se necessário e deve ser dado.

Isto pode ser feito de alguma forma usando callbacks?

o meu código para começar que, claro, não reflecte o padrão pretendido: 

@click.command()
@click.option('--authentication-token', prompt=True, required=True)
@click.option('--username', prompt=True, required=True)
@click.option('--password', hide_input=True, prompt=True, required=True)
def login(authentication_token, username, password):
    print(authentication_token, username, password)

if __name__ == '__main__':
    login()
Author: Stephen Rauch, 2017-05-29
Source

2 answers

Isto pode ser feito construindo uma classe personalizada derivada de click.Option, e nessa classe sobre montar o método click.Option.handle_parse_result() Como:

Classe Personalizada: 

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)

Usando A Classe Personalizada:

Para usar a classe personalizada, passe o parâmetro cls para click.option decorador como: 

@click.option('--username', prompt=True, cls=NotRequiredIf,
              not_required_if='authentication_token')
Como é que isto funciona? Isto funciona porque a click é uma estrutura bem desenhada. O decorador @click.option() normalmente instancia um objecto click.Option mas permite que este comportamento seja sobreposto com o parâmetro cls. Portanto, é relativamente fácil herdar de click.Option na nossa própria classe e sobrevier os métodos desejados.

Neste caso, ultrapassamos o passeio click.Option.handle_parse_result() e desactivamos a necessidade de user/password Se authentication-token token estiver presente, e queixamo-nos se ambos user/password estão presentes.

Nota: esta resposta foi inspirada por esta resposta.

Código De Ensaio: 

@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())

Resultados:

De login('--username name --password pword'.split()):

t:None  u:name  p:pword

De 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.
 13
Author: Stephen Rauch, 2018-02-27 17:45:40

Melhorou ligeiramente a resposta de Stephen Rauch para ter vários parâmetros mutex.

import click

class Mutex(click.Option):
    def __init__(self, *args, **kwargs):
        self.not_required_if:list = kwargs.pop("not_required_if")

        assert self.not_required_if, "'not_required_if' parameter required"
        kwargs["help"] = (kwargs.get("help", "") + "Option is mutually exclusive with " + ", ".join(self.not_required_if) + ".").strip()
        super(Mutex, self).__init__(*args, **kwargs)

    def handle_parse_result(self, ctx, opts, args):
        current_opt:bool = self.name in opts
        for mutex_opt in self.not_required_if:
            if mutex_opt in opts:
                if current_opt:
                    raise click.UsageError("Illegal usage: '" + str(self.name) + "' is mutually exclusive with " + str(mutex_opt) + ".")
                else:
                    self.prompt = None
        return super(Mutex, self).handle_parse_result(ctx, opts, args)

Usar assim: 

@click.group()
@click.option("--username", prompt=True, cls=Mutex, not_required_if=["token"])
@click.option("--password", prompt=True, hide_input=True, cls=Mutex, not_required_if=["token"])
@click.option("--token", cls=Mutex, not_required_if=["username","password"])
def login(ctx=None, username:str=None, password:str=None, token:str=None) -> None:
    print("...do what you like with the params you got...")
 0
Author: masi, 2018-07-09 01:22:21