Pythonクリックのデフォルトオプションを-hに設定するにはどうすればよいですか？

メソッドを継承しclick.Commandてオーバーライドするparse_args()場合は、次のようにデフォルトのカスタムクラスを作成できます。

カスタムクラス

import click

class DefaultHelp(click.Command):
    def __init__(self, *args, **kwargs):
        context_settings = kwargs.setdefault('context_settings', {})
        if 'help_option_names' not in context_settings:
            context_settings['help_option_names'] = ['-h', '--help']
        self.help_flag = context_settings['help_option_names'][0]
        super(DefaultHelp, self).__init__(*args, **kwargs)

    def parse_args(self, ctx, args):
        if not args:
            args = [self.help_flag]
        return super(DefaultHelp, self).parse_args(ctx, args)

カスタムクラスの使用：

カスタムクラスを使用するには、次のようにclsパラメータを@click.command()デコレータに渡します。

@click.command(cls=DefaultHelp)

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

クリックは適切に設計されたOOフレームワークであるため、これは機能します。@click.command()デコレータは通常、インスタンス化しclick.Commandたオブジェクトをしかし、この動作が終わると苦しむことを可能にするclsパラメータ。したがってclick.Command、私たち自身のクラスから継承し、目的のメソッドを乗り越えるのは比較的簡単なことです。

この場合click.Command.parse_args()、オーバーライドして空の引数リストをチェックします。空の場合は、ヘルプを呼び出します。さらに、このクラスは、['-h', '--help']他に設定されていない場合、デフォルトでヘルプを設定します。

テストコード：

@click.command(cls=DefaultHelp)
@click.option('--toduhornot', is_flag=True, help='prints "duh..."')
def duh(toduhornot):
    if toduhornot:
        click.echo('duh...')

if __name__ == "__main__":
    commands = (
        '--toduhornot',
        '',
        '--help',
        '-h',
    )

    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)
            duh(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)]
-----------
> --toduhornot
duh...
-----------
> 
Usage: test.py [OPTIONS]

Options:
  --toduhornot  prints "duh..."
  -h, --help    Show this message and exit.
-----------
> --help
Usage: test.py [OPTIONS]

Options:
  --toduhornot  prints "duh..."
  -h, --help    Show this message and exit.
-----------
> -h
Usage: test.py [OPTIONS]

Options:
  --toduhornot  prints "duh..."
  -h, --help    Show this message and exit.