web-dev-qa-db-ja.com

[コマンドラインインターフェイス]をクリックします。他のオプションオプションが設定されていない場合は、オプションを必須にします。

Python クリックライブラリ を使用してコマンドラインインターフェイス（CLI）を記述する場合、たとえば、2番目と3番目のオプションが必要な場合にのみ3つのオプションを定義できます。最初の（オプション）は設定されていませんか？

私の使用例は、authentication token（オプション1）またはusername（オプション2）とpassword（オプション3）。

トークンが指定されている場合、usernameおよびpasswordが定義されているかどうかを確認したり、プロンプトを表示したりする必要はありません。それ以外の場合、トークンが省略されていると、usernameおよびpasswordが必須になり、指定する必要があります。

これはどういうわけかコールバックを使用して行うことができますか？

もちろん、意図したパターンを反映していない、開始するための私のコード：

@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()
pythoncommand-line-interfacepython-click
14
Dirk

これを行うには、_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')
_

これはどのように作動しますか？

これはクリックがうまく設計されているため機能しますOOフレームワーク。@click.option()デコレータは通常_click.Option_オブジェクトをインスタンス化しますが、この動作をclsパラメータです。そのため、独自のクラスで_click.Option_から継承し、目的のメソッドをオーバーライドすることは比較的簡単です。

この場合、click.Option.handle_parse_result()に乗って、_user/password_トークンが存在する場合は_authentication-token_の必要性を無効にし、_user/password_が_authentication-token_が存在する場合は文句を言う。

注：この回答は this answer からヒントを得ています

テストコード：

_@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.
_
21
Stephen Rauch

わずかに改善 Stephen Rauch's answer 複数の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)

次のように使用します：

@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...")
4
masi