5.1 dashライブラリー

portsモジュール

タスクノードの入出力ポートに接続されているファイルに対してアクセスできます。

詳細は、「dashlib.ports」を参照してください。

eventモジュール

タスクノードの実行状態を表示できます。

詳細は、「dashlib.event」を参照してください。

dbモジュール

データベースに対してクエリを実行できます。

詳細は、「dashlib.db」を参照してください。

import dashlib

dashlib.usage()

dashlib.ports.usage()

各関数の説明など、portsモジュールの説明を表示します。

dashlib.ports.list()

対象のタスクノードで利用できるポート名の一覧を表示します。ここで表示されるポート名は、これ以降の項目の<ポート名>として使用できます。

dashlib.ports.<ポート名>(mode)

dashlib.ports.<ポート名>.asFile(mode)のエイリアスです。

ポートに接続済のファイルのファイルオブジェクトを取得します。

存在しないポートにアクセスすると、PortNotFoundエラーが発生します。

ポートだけ存在し、データノードを接続していない場合、LinkNotFoundエラーが発生します。

ポートにディレクトリーを接続した場合、IsADirectoryErrorが発生します。

表 5.1 引数

引数	説明
mode(str)	省略できます。Pythonの組み込み関数open関数のmodeに渡されます。 省略した場合、入力ポートの場合は"r"が、出力ポートの場合は"w"が自動的に使用されます。

dashlib.ports.<ポート名>.path

ポートに接続されているファイルにアクセスするためのフルパスを取得できます。

このプロパティを用いて、ディレクトリーなどに対するアクセスなどのコードを記述できます。

存在しないポートにアクセスすると、PortNotFoundエラーが発生します。

ポートだけ存在し、データノードが接続されていない場合、LinkNotFoundエラーが発生します。

ポートの接続例

タスクノードとデータノードを接続する場合、そのタスクのJupyter Notebookの画面上でタスクスクリプトを以下のように実行することで、Pythonのファイルオブジェクトを取得、利用できます。

図 5.1 ポートの接続例

import dashlib as dash

# 1. 入力ポートから内容を読み取り
f1 = dash.ports.In1()
in1_content = f1.read()
f1.close()

# 2. 出力ポートに内容を書き込み(*)

with dash.ports.Out1() as f:
    f.write(in1_content)

*: dashlib.ports.<ポート名>は、Python の open関数と同様のインターフェイスを持つため、withも利用できます。

dashlib.event.Message.sendNodeProgress(comment, progressRatio)

Pythonソースコードの任意の場所で呼び出すと、キャンバス上のタスクノードの下部に、コメントおよび進捗率を出力できます。進捗率自体は、自分で計算して出力する必要があります。

この関数はフローの実行時だけ有効です。

タスクノードの[edit this task]アイコンからJupyter Notebookの画面を開いて、Jupyter Notebook単体での実行時には、利用できません。

表 5.2 引数

引数	説明
comment(str)	タスクノードの下部に表示されるコメントです。
progressRatio(int)	0～100の間の値を指定できます。省略できます。