| On this page |
パッケージレベルの関数
以下のトップレベルアトリビュート関数は、Pythonエクスプレッションで使用できるように設計されています。
pdg.workItem()を使用することで、Pythonエクスプレッションで現行ワークアイテムオブジェクトを取得することができます。
floatData(work_item, "foo", 0)トップレベル関数は、work_item.data.floatData("foo", 0)と等価です。そして、@fooHScriptエクスプレッションと等価です。
浮動小数点
floatData(work_item, attribute_name, index=0)
→ float
指定したpdg.WorkItemオブジェクト上のアトリビュート名のindex番目の浮動小数点値を返します。
floatDataArray(work_item, attribute_name)
→ list
of float
指定したpdg.WorkItemオブジェクト上のアトリビュート名の浮動小数点値の全リストを返します。
hasFloatData(work_item, attribute_name)
→ bool
pdg.WorkItemオブジェクトに、指定した名前の浮動小数点アトリビュートが存在すればTrueを返します。
整数
intData(work_item, attribute_name, index=0)
→ int
整数アトリビュートに関してはfloatData()と同様です。
intDataArray(work_item, attribute_name)
→ list
of int
整数アトリビュートに関してはfloatDataArray()と同様です。
hasIntData(work_item, attribute_name)
→ bool
整数アトリビュートに関してはhasFloatData()と同様です。
文字列
strData(work_item, attribute_name, index=0)
→ str
文字列アトリビュートに関してはfloatData()と同様です。
strDataArray(work_item, attribute_name)
→ list
of str
文字列アトリビュートに関してはfloatDataArray()と同様です。
hasStrData(work_item, attribute_name)
→ bool
文字列アトリビュートに関してはhasFloatData()と同様です。
ユーティリティ
input(index=None, tag=None, localize=False)
→ list
or str
現行ワークアイテムの 入力 ファイルを返します。
これは、Pythonエクスプレッションを使用できるように設計されています。HScriptエクスプレッションの@pdg_inputと等価です。
戻りタイプは、indexキーワード引数によって異なります。index=Noneの場合、この関数は入力ファイルのリストを返します。それ以外の場合、index番目の入力ファイルパスを返します。
resultData(work_item, tag, localized=False, as_list=False)
→ list
or str
pdg.WorkItemオブジェクト上の指定したタグを持った出力ファイル(s)を返します。
localized=Trueの場合、そのパス内の__PDG_DIR__トークンが現行マシンに展開されます。
戻りタイプは、as_listキーワード引数によって異なります。as_list=Falseの場合、この関数はスペース区切りの文字列でファイルパスを返します。それ以外の場合、パス文字列のリストを返します。
resultDataIndex(work_item, tag, index, localized=False)
→ str
pdg.WorkItemオブジェクトの指定したtagが付いたindex番目の出力ファイルを返します。
localized=Trueの場合、そのパス内の__PDG_DIR__トークンが現行マシンに展開されます。
hasResultData(work_item, tag)
→ bool
pdg.WorkItemに指定したタグの出力ファイルが存在すれば、Trueを返します。
エクスプレッション関数
workItem()
→ pdg.WorkItem
これは、Pythonエクスプレッションを使用できるように設計されています。現行ワークアイテムオブジェクトを返します。
kwargs(key=None)
→ obj
or dict
これは、Pythonエクスプレッションを使用できるように設計されています。エクスプレッション評価コンテキストからローカル変数を照会します。
戻りタイプは、keyキーワード引数によって異なります。key=Noneの場合、この関数はすべてのローカル変数をdictとして返します。それ以外の場合、指定したkeyの値を返します。
API
cooking
-
クックオプション用コンテナ。
-
指定可能なクックモードの列挙値。
data
-
PDGデータタイプの列挙値。
-
onGenerateコールバックで実行されるワークアイテム生成のタイプ。
events
-
グラフが走っている間に発生したイベントを表現します。
-
ノードまたはグラフに追加されたハンドラー関数を表現します。
-
pdg.Eventのタイプ。
exceptions
-
グラフを走らせてエラーが発生した時の汎用的な例外。
expressions
-
スレッドローカル評価コンテキストに作用するグローバル関数を含んだモジュール。
nodes
-
ノードの外部依存関係を表現します。
-
ノードの外部ファイルへの依存性を表現します。
-
GraphContextオブジェクト内のディペンデンシーグラフを表現します。
-
ディペンデンシーグラフのトップレベルオブジェクト。
-
ディペンデンシーグラフノードの基本クラス。
-
PDGノードの入力、出力、パラメータ。
-
プロセッサを表現したディペンデンシーグラフノードのサブクラス。
-
PDGノードタイプのサブタイプ。
-
PDGノードの主要タイプ。
-
pdg.Portオブジェクトのタイプ。
schedulers
-
Pythonで実装されたタイプを持つスケジューラオブジェクト。
types
-
カスタムPDGタイプを定義する際に使用する言語の列挙値。
-
カスタムクラスをPDGに登録する時のオブジェクトのタイプ。
-
ノードコールバック実装の戻りタイプ。
-
スケジューラのonSchedulerコールバック実装の戻りタイプ。
workitems
-
これは"バッチ"ワークアイテムを表現します。ここには複数の子ワークアイテムが含まれています。
-
PDGグラフ内のワークアイテム
-
Pythonを介してワークアイテムデータにアクセスするメソッドを備えています。
-
ワークアイテムのコンテナオブジェクト。
-
このオブジェクトをWorkItemHolder.addWorkItem()に渡すことで、その指定されたオプションでワークアイテムを作成することができます。
-
バッチのアクティブ条件の列挙値。
-
ワークアイテムを生成する時に使用可能なクローンモードの列挙値。
-
ワークアイテムのクックステート。
-
ワークアイテムのタイプ。
