7.20 usecase run コマンド

usecase run コマンドは、指定されたエントリポイントからスクリプトを実行します。

コマンドラインからユース ケース スクリプトを実行するための基本的な構文は以下のとおりです。

usecase run script_name [options]

使用できるオプションは、スクリプト内の現在のユース ケースの $Options$ タグによって参照されるメソッドで定義されます。ロード済みのファイルの詳細については、usecase help コマンドを使用して表示できます。

コマンドラインでオプションを設定するための構文は、--options.name=value または --options.name value です。オプションの値が明示的に指定されていない場合、オプションは、スクリプトで定義されたデフォルトを取得します。

注:

この例では、オプションのトップ レベル グループの名前として options が使用されています。ただし、ユース ケース スクリプトで、オプションのトップ レベル グループに別の名前を指定することもできます。

スクリプトの絶対パスを指定するのではなく、usecase run コマンドを発行する場合は、スクリプト名の前で -p または -s フラグを指定します。たとえば、現在のプラットフォームのユース ケース スクリプトを実行するには、usecase run -p script_name [options] を発行します。

1 つのスクリプトで複数のユース ケースが定義されている場合は、スクリプトを実行するときに使用するエントリ ポイントまたはメイン メソッドを定義する必要があります。複数のユース ケースが定義されているスクリプトの場合は、構文は usecase run script_name entry_point [options] となります。

ユース ケースのエントリ ポイントが位置引数を受け入れる場合、スクリプトの実行時にコマンドラインでこれらの引数を宣言する必要があります。たとえば、現在の作業ディレクトリのユース ケース スクリプト positional.py のメイン メソッドが以下のように定義されている場合、

...
$Run$ main
...
def main(script, filename, value):
        print("Running the main method")

スクリプトを実行するための構文は以下のようになります。

usecase run positional.py [options] filenamevalue

例 7-17 例

usecase run myscript.py --options.enableETM=True --options.enableETM.timestamping=True
        --options.traceCapture "DSTREAM"

このユース ケースについて定義されたオプションを設定して、現在の作業ディレクトリの myscript.py という名前のユース ケース スクリプトを実行します。

usecase run multipleEntry.py mainOne --options.traceCapture "ETR"

現在の作業ディレクトリの multipleEntry.py という名前のユース ケース スクリプトを実行します。このユース ケース スクリプトのエントリ ポイントは mainOne です。エントリポイントの後で 1 つのオプションが指定されます。

usecase run -s multipleScript.py mainTwo filename.txt 100

現在の作業ディレクトリの multipleScript.py コンフィギュレーション データベース内の /Scripts/usecase/ ディレクトリでユース ケース スクリプトを実行します。このユース ケース スクリプトのエントリ ポイントは mainTwo で、2 つの位置引数を定義します。スクリプトに指定されたオプションはありません。

保存のオプション

コマンドラインで、異なる接続でスクリプトが実行されるたびに入力する長いオプションのリストを指定するのは面倒な場合があります。解決策の 1 つは、組み込み機能 --save-options を使用することです。

たとえば、スクリプト usecase run script_name --option1=..., --option2=...--save-options=/path/to/options.txt ( options.txt はオプションを保存するファイル) を実行できます。この操作により、実行時に、オプションがこのユース ケース スクリプト (options.txt) に保存されます。

コマンドラインでオプションが指定されない場合、そのデフォルト値は指定されたファイルに保存されます。

ロードのオプション

ファイルにオプションを保存すると、同様の仕組みを使用して再度ロードできます。usecase run script_name --load-options=path/to/options.txt を発行すると options.txt からオプションがロードされ、正常にロードされたら、スクリプトが実行されます。

コマンドラインでオプションを指定し、ファイルからロードすることで、オプションを組み合わせることができます。コマンドラインからのオプションは、ファイルからロードされたオプションをオーバーライドします。

例:

myscript.py のオプションファイル options.txt には以下の 2 つのオプション値が含まれています。

  • options.a=10.
  • options.b=20.

usecase run myscript.py --load-options=options.txt を実行すると、指定されたファイルから値 10 を持つ options.a と値 20 を持つ options.b がロードされます。たとえば、オプションがコマンドライン usecase run --options.b=99 --load-options=options.txt で設定された場合、ファイルから取得されたオプションはオーバーライドされます。options.a は値 10 を取得しますが、options.b はコマンドラインで指定され、このファイルに保存されている値とは異なる新しい値である 99 を取得します。これは、1 つのユース ケースのオプションの標準セットを保存し、実行時に必要なオプションのみを変更する場合に便利です。

表示のオプション

スクリプトを実行する場合、オプションが外部のファイルからロードされた場合でも、使用されるオプションをユーザが確認する必要がある場合があります。組み込みオプション --show-options は、スクリプトが実行されたときにスクリプトで使用されるすべてのオプションの名前と値を表示します。

例 7-18 例

usecase run script_name --show-options

このスクリプトのデフォルトのオプションのリストを出力します。

usecase run script_name --option1=x, --option2=y --show-options

option1 および option2 の更新された値を使用して、スクリプトのオプションのリストを出力します。

usecase run script_name --load-options=file --show-options

指定されたファイルから値を取得して、オプションのリストを出力します。ロードされたファイルでオプションが定義されていない場合、そのデフォルト値が出力されます。

非機密扱いPDF file icon PDF 版ARM DUI0446ZJ
Copyright © 2010–2016 ARM.All rights reserved.