| On this page |
パッケージレベルの関数 ¶
以下のトップレベルアトリビュート関数は、Pythonエクスプレッションを使ってパラメータ内で使用できるように設計されています。
pdg.workItem()を使用することで、Pythonエクスプレッションで現行ワークアイテムオブジェクトを取得し、そのpdg.WorkItemクラスから他のメソッドとプロパティにアクセスすることができます。
例えば、pdg.workItem().floatAttribValue("foo", 1)とpdg.WorkItem()["foo"][1]のPythonエクスプレッションは、@foo.1のHScriptエクスプレッションと等価です。
attrib(name, index=None, default_value=None)
→ object
現行ワークアイテムから、指定したnameのアトリビュート配列またはアトリビュート値を返します。
これは、Pythonエクスプレッションで使用するように設計されています。
HScriptエクスプレッションの@name.indexまたはpdgattrib(..)やpdgattribs(..)の関数と等価です。
返されるタイプは、indexキーワード引数に依存します。
index=Noneの場合、この関数は、指定したアトリビュートに含まれているすべての値を配列で返します。
それ以外の場合、指定したインデックスでの値を返します。
この値(s)のタイプは、そのアトリビュート自体のタイプ(例えば、int、float、pdg.Fileなど)に依存します。
default_valueを指定することで、アクティブなワークアイテムがなかった場合、または、そのアトリビュートがワークアイテム上になかった場合に返す値を決めることができます。
input(index=None, tag=None, localize=False)
→ list
or str
現行ワークアイテムの 入力 ファイルを返します。
これは、Pythonエクスプレッションで使用するように設計されています。HScriptエクスプレッションの@pdg_inputまたはpdginput(..)関数と等価です。
戻りタイプは、indexキーワード引数によって異なります。index=Noneの場合、この関数は入力ファイルのリストを返します。それ以外の場合、‹index›番目の入力ファイルパスを返します。
isEvaluating()
→ bool
コールしているスレッドがPDGワークアイテムを評価している場合はTrue、それ以外の場合はFalseを返します。
これは、Pythonエクスプレッションで使用するように設計されています。
HScriptエクスプレッションのispdgeval()と等価です。.
kwargs(key=None)
→ obj
or dict
エクスプレッション評価コンテキストからローカル変数を照会します。
これは、Pythonエクスプレッションで使用するように設計されています。この関数に相当するHScriptエクスプレッションはありません。
戻りタイプは、keyキーワード引数によって異なります。key=Noneの場合、この関数はすべてのローカル変数をdictとして返します。それ以外の場合、指定したkeyの値を返します。
workItem()
→ pdg.WorkItem
現行ワークアイテムオブジェクトを返します。
これは、Pythonエクスプレッションで使用するように設計されています。
この関数が返すワークアイテムオブジェクトは、pdgattrib(..)またはpdginput(..)などのHScriptエクスプレッションや@attrib参照を評価するのに使用されるオブジェクトと同じです。
API ¶
attributes ¶
-
辞書配列のワークアイテムアトリビュート。
-
ファイル配列のワークアイテムアトリビュート。
-
浮動小数点配列のワークアイテムアトリビュート。
-
整数配列のワークアイテムアトリビュート。
-
アトリビュート名をパターンにマッチングさせるユーティリティ。
-
Pythonオブジェクトのワークアイテムアトリビュート。
-
ワークアイテムのリストをアトリビュート値またはフレーム値で分割するユーティリティ。
-
文字列配列のワークアイテムアトリビュート。
-
pdg.AttributePatternとpdg.ValuePatternの基底クラス。
-
パスと関連メタデータを持ったファイルオブジェクト。
-
アトリビュート値の範囲をマッチングさせるためのユーティリティ。
-
ファイルパスをマッピングする関数。
-
グローバルパスマップ内のエントリ。
-
値のマッチングまたは値の配列を生成するためのユーティリティ。
-
アトリビュートをワークアイテムに追加した時のエラー処理オプションの列挙値。
-
ワークアイテムアトリビュートのフラグの列挙値。
-
デフォルトのアトリビュートパターンマッチタイプの列挙値。
-
アトリビュートに適用可能な色々なマージ操作の列挙。
-
ワークアイテムアトリビュートの上書きオプションの列挙値。
-
ワークアイテムアトリビュートのタイプの列挙値。
-
ファイル転送の宛先タイプの列挙値。
-
ファイルタイプの列挙値。
-
パスマッピングエントリと入力文字列を比較する時に使用される文字列マッチングタイプの列挙値。
cooking ¶
-
クックオプション用コンテナ。
-
グラフ評価オプション用のコンテナ。
-
プロセッサ系ノードで利用可能なファイルキャッシュモードの列挙値。
-
指定可能なクックモードの列挙値。
-
プロセッサ系ノードが対応しているワークアイテム生成モードの列挙値。
-
クック中にノードがワークアイテムを再生成する理由の列挙値。
customtypes ¶
-
Dictionary Arrayアトリビュートで使用できるように、入れ子になった辞書オブジェクトをPythonでラップします。
data ¶
-
PDGデータタイプの列挙値。
-
Generate系コールバックで実行されるワークアイテム生成のタイプ。
debugging ¶
-
キャッシュデバッグログレベルの列挙値。
-
アトリビュートエクスプレッションデバッグログレベルの列挙値。
-
ノードデバッグログレベルの列挙値。
-
スケジューラデバッグログレベルの列挙値。
-
サービスデバッグログレベルの列挙値。
-
ファイル転送デバッグログレベルの列挙値。
-
pdg.debugLevelTypeRegistration
タイプ登録デバッグログレベルの列挙値。
-
ワークアイテムデバッグログレベルの列挙値。
-
PDGで利用可能なデバッグログの列挙値。
-
デバッグログユーティリティ。
events ¶
-
グラフが走っている間に発生したイベントを表現します。
-
イベントを発行することができるオブジェクトの基底クラス。
-
ノードまたはグラフに追加されたハンドラー関数を表現します。
-
pdg.Eventのタイプ。
-
Pythonからノード/グラフに追加されたハンドラー関数を表現します。
exceptions ¶
-
ワークアイテムアトリビュートにアクセスした際にエラーが発生した時に引き起こす一般的な例外。
-
グラフを走らせてエラーが発生した時の汎用的な例外。
-
PDG Service Managerの処理中にエラーが発生した時に引き起こされる汎用例外。
expressions ¶
-
スレッドローカル評価コンテキストに作用するグローバル関数を含んだモジュール。
internal ¶
-
ノードとそのワークアイテムに関するメモリ情報。
nodes ¶
-
ノードの外部依存関係を表現します。
-
フィードバックループの開始ブロック用のディペンデンシーグラフプロセッサノードのサブクラス。
-
ノードの外部ファイルへの依存性を表現します。
-
GraphContextオブジェクト内のディペンデンシーグラフを表現します。
-
ディペンデンシーグラフのトップレベルオブジェクト。
-
ディペンデンシーグラフノードの基底クラス。
-
pdg.Nodeインスタンスの設定に使用される要約情報。
-
PDGノードの生成/クック時間に関する情報。
-
PDGノードの入力、出力、パラメータ。
-
プロセッサを表現したディペンデンシーグラフノードのサブクラス。
-
PDGノードが公開するクック時間の統計。
-
PDGノードタイプのサブタイプ。
-
PDGノードの主要タイプ。
-
pdg.Portオブジェクトのタイプ。
schedulers ¶
-
Pythonで実装されたタイプを持つスケジューラオブジェクト。
-
ディペンデンシーグラフ内のスケジューラを表現します。
-
スケジューラがワークアイテムデータをリモートマシンに転送できる方法。
services ¶
-
サービスを表現したオブジェクト。
-
起動中のサービスクライアントに関する情報を含んだオブジェクト。
-
すべてのPDGサービスの登録を含んだオブジェクト。
-
サービスブロック内のワークアイテムをクックする方法を決めるオプションの列挙値。
-
サービスクライアントで使用されるログタイプ。
-
PDGサービスの所有者を示します。
-
メモリが超過した時にクライアントをリセットするようにサーバーを構成する時に使用するリセット操作タイプ。
-
PDGサービスの状態を示します。
types ¶
-
カスタムのファイル転送ハンドラーの結果を返すユーティリティクラス。
-
カスタムノード、ワークアイテム、スケジューラタイプすべてのレジストリを含んだオブジェクト。
-
onAcceptWorkItemコールバックの戻りタイプ。
-
カスタムキャッシュハンドラーから返すことができるキャッシュ結果の列挙。
-
設定可能なDirtyハンドラータイプの列挙。
-
カスタムPDGタイプを定義する際に使用する言語の列挙値。
-
カスタムRegenerationハンドラーが返すことができる結果の列挙値。
-
カスタムクラスをPDGに登録する時のオブジェクトのタイプ。
-
ノードコールバック実装の戻りタイプ。
-
スケジューラのonSchedulerコールバック実装の戻りタイプ。
-
onTickコールバックの戻りタイプ。
-
カスタムのファイル転送ハンドラーが返すことができるファイル転送結果の列挙。
-
スケジューラのisWorkItemReadyコールの戻りタイプ
workitems ¶
-
これはバッチワークアイテムを表現します。ここには複数の子ワークアイテムが含まれています。
-
読み込み専用ワークアイテムのリスト。
-
ディペンデンシーペア用のコンテナオブジェクト。
-
パーティション内のワークアイテムを追跡します。
-
Pythonスクリプトを使用してクックするワークアイテムのカスタムワークアイテムデータタイプ。
-
PDGグラフ内のワークアイテム
-
Pythonを介してワークアイテムデータにアクセスするメソッドを備えています。
-
後で適用できるように進行中のワークアイテムのDirty(変更あり)操作を保存します。
-
ワークアイテムのコンテナオブジェクト。
-
ワークアイテムのリスト。
-
このオブジェクトをWorkItemHolder.addWorkItem()に渡すことで、その指定されたオプションでワークアイテムを作成することができます。
-
ワークアイテムのクック時間の情報。
-
バッチのアクティブ条件の列挙値。
-
ワークアイテムを生成する時に使用可能なクローンモードの列挙値。
-
プラットフォームの列挙値。
-
ワークアイテムの現在のキャッシュ状態。
-
ワークアイテムのクックタイプ。
-
PDGグラフで実行されるDirty(変更あり)操作のタイプ。
-
ワークアイテムの実行タイプ。
-
ワークアイテムのログメッセージのタイプ。
-
PDGワークアイテムが吐き出した処理時間の統計情報。
-
ワークアイテムのクックステート。
-
ワークアイテムのタイプ。
