pdg.WorkItemの入力、出力、ファイルアトリビュートで使用されるファイルオブジェクト。
各ファイルオブジェクトには、__PDG_DIR__
と__PDG_TEMP__
のトークンを使ったプラットフォームに依存しないパス、ファイルタイプ、更新日時が含まれています。
メソッド ¶
静的メソッド ¶
mapPath(path, zone)
Static method
指定したパスを指定したゾーンにマップしたバージョンのパスを返します。
この関数は廃止されました。代わりにpdg.PathMap.mapPathを使用してください。
mapPathToLocal(path)
Static method
指定したパスをローカルゾーンにマップしたバージョンのパスを返します。
この関数は廃止されました。代わりにpdg.PathMap.mapPathToLocalを使用してください。
mappingZone()
Static method
ローカルマッピングゾーンを返します。
この関数は廃止されました。代わりにpdg.PathMap.mappingzoneを使用してください。
pathMapJSON()
Static method
PDG Path MapをJSON文字列として返します。
この関数は廃止されました。代わりにpdg.PathMap.pathMapJSONを使用してください。
setMappingZone(zone)
Static method
ローカルマッピングゾーンを設定します。
この関数は廃止されました。代わりにpdg.PathMap.setMappingZoneを使用してください。
setPathMapJSON(zone)
Static method
JSON文字列からPDG Path Mapを設定します。
この関数は廃止されました。代わりにpdg.PathMap.setPathMapJSONを使用してください。
インスタンスメソッド ¶
__init__()
新しい空っぽのファイルオブジェクトを構築します。
__init__(path, own)
指定した名前と所有者フラグを使ってFileオブジェクトを構築します。
ファイルオブジェクトを格納するワークアイテムによってファイルを生成する場合は、own
をTrue
に設定してください。
そのファイルのタグと更新日時はPDGによって自動的に計算されます。
__init__(path, tag, modtime, own)
指定した名前、タグ、更新日時、独自のフラグでファイルオブジェクトを構築します。
ファイルオブジェクトを格納するワークアイテムによってファイルを生成する場合は、これをTrue
に設定してください。
asTuple()
→ tuple
このファイルオブジェクトの(path, tag, hash, own)
値を含んだタプルを返します。
localizePath(scheduler)
→ str
指定したスケジューラを使用して、このファイルオブジェクトに格納されているパスの場所を決めます。
updateStat(work_item=None, force=false)
設定済みの独自のFile Statハンドラーを使用するか、または、ハンドラーが何もインストールされていない場合は直接ファイルの状態を確認することで、ファイルのハッシュとサイズを更新します。
DefaultArchiveTag
: str
Static method Property
アーカイブに使用されるファイルタグ。
DefaultCsvTag
: str
Static method Property
CSVファイルに使用されるファイルタグ。
DefaultDirTag
: str
Static method Property
ディレクトリに使用されるファイルタグ。
DefaultFileTag
: str
Static method Property
特定のファイルタイプを持たないファイルパスに使用されるファイルタグ。
DefaultGeoTag
: str
Static method Property
特定のファイルタイプを持たないジオメトリパスに使用されるファイルタグ。
DefaultHdaTag
: str
Static method Property
HDAファイルに使用されるファイルタグ。
DefaultHipTag
: str
Static method Property
hipファイルに使用されるファイルタグ。
DefaultImageTag
: str
Static method Property
画像に使用されるファイルタグ。
DefaultPythonScriptTag
: str
Static method Property
Pythonスクリプトに使用されるファイルタグ。
DefaultSymLinkTag
: str
Static method Property
シンボリックリンクに使用されるファイルタグ。
DefaultTxtTag
: str
Static method Property
プレーンテキストファイルに使用されるファイルタグ。
DefaultUsdTag
: str
Static method Property
USDファイルに使用されるファイルタグ。
DefaultVideoTag
: str
Static method Property
動画に使用されるファイルタグ。
path
: str
Property
ファイルオブジェクトが作成された時にそのファイルオブジェクトに格納されているパス。
local_path
: str
Property
ファイルオブジェクトに格納されているパスをローカルゾーンにマッピングしたパス。
hash
: int
Property
ファイルの更新日時またはハッシュを格納することができます。
owned
: bool
Property
このオブジェクトを格納したワークアイテムでそのファイルが所有されているかどうか。
size
: int
Property
ディスク上のファイルのサイズ。
type
: pdg.fileType
Property
(例えば、ワークアイテムが生成された時やワークアイテムがクックされた時に追加された時の)ファイルのタイプ。