bokeh.command.subcommand¶

Bokehコマンドラインアプリケーションのサブコマンドを定義するための基本クラスを提供する。

class Subcommand(parser: argparse.ArgumentParser)[ソース]¶

子命令の抽象基底クラス

サブクラスは実現すべきだ invoke(self, args) 方法は，この方法はargparse処理後のパラメータのセットを入力として受け取る.

サブクラスはまた，以下のクラス属性を定義すべきである.

name この子命令の名前
help このサブコマンド用argparseのヘルプ文字列
args the parameters to pass to parser.add_argument

書類の書式 args 以下の形態のタプルシーケンスであるべきである。

('argname', dict(
    metavar='ARGNAME',
    nargs='+',
))

例を引く

簡単なサブコマンド“foo”は以下のようになるかもしれません。

class Foo(Subcommand):

    name = "foo"
    help = "performs the Foo action"
    args = (
        ('--yell', dict(
            action='store_true',
            help="Make it loud",
        )),
    )

    def invoke(self, args):
        if args.yell:
            print("FOO!")
        else:
            print("foo")

そして実行します bokeh foo --yell 印刷されます FOO! コンソールの上にあります。

__init__(parser: argparse.ArgumentParser) → None [ソース]¶

その解析器を用いてサブコマンドを初期化する

パラメータ: parser (Parser) -- Argparseです Parser インスタンスは，このサブ命令のパラメータを構成する.

この方法では、記述されたすべてのパラメータを自動的に追加します self.args それがそうです。サブクラスは正しいことができる self.parser それがそうです。

abstract invoke(args: argparse.Namespace) → Optional[bool][ソース]¶

メインフローを引き継ぎ、サブコマンドを実行します。

この方法はサブクラスで実現されなければならない. サブクラス化された上書きメソッドは異なるタイプを返す：Bool：Build None：FileOutput(サブクラス化はHTML，SVG，JSON).PNG上書きFileOutput.Invokeメソッド)，Info，Init，SampleData，Secret，Serve，Static

パラメータ: args (argparse.Namespace) -- サブコマンドのコマンドラインパラメータを解析する.
例外: NotImplementedError --