リソース¶
pme.resources は、登録されたリソースフォルダーとアイコン用フォルダー、
その中のスクリプトとアイコンのファイル、スクリプト参照の解決結果を読み取ります。PME が現在使用している リソース設定 を読み取り、
何も変更しません。外部スクリプトからは、pme を
短縮エイリアスまたはパッケージ名による読み込み で参照します。
Added in version 2.2.0: 登録フォルダー、スクリプトとアイコンのファイル、スクリプト参照の解決を取得する読み取り専用の照会です。API の安定性は Experimental です。
関数 |
用途 |
|---|---|
登録されたリソースフォルダーを、現在の状態とともに返します。 |
|
登録されたアイコン用フォルダーを、現在の状態とともに返します。 |
|
それらのフォルダー内のスクリプトとアイコンのファイルを列挙します。 |
|
スクリプト実行と同じ方法でスクリプト参照を解決します。 |
結果は変更不可の dataclass です。dataclasses.asdict() は、入れ子のフォルダーも含めて結果を辞書に変換します。
フォルダー¶
- pme.resources.list_folders()¶
登録されたリソースフォルダーを、保存順に現在の状態とともに返します。
- 戻り値:
登録フォルダーごとに一つのエントリ。存在しない場所も含みます。
- 戻り値の型:
tuple[ResourceFolderInfo, ...]
- 例外:
RuntimeError -- リソース設定を読めず、以前の有効な設定もない場合。 メッセージは
"Resource settings are unavailable"。
補足
リソースフォルダーが登録されていない場合、結果は空です。既定のフォルダーは作成しません。
- pme.resources.list_icon_folders()¶
登録されたアイコン用フォルダーを、保存順に現在の状態とともに返します。
アイコン用フォルダーは、リソースフォルダーとは別に登録します。
- 戻り値:
登録されたアイコン用フォルダーごとに一つのエントリ。
nameは""。- 戻り値の型:
tuple[ResourceFolderInfo, ...]
- 例外:
RuntimeError -- リソース設定を読めず、以前の有効な設定もない場合。 メッセージは
"Resource settings are unavailable"。
補足
結果が空の場合、同梱のアイコンだけを使います。既定のフォルダーは作成しません。
- class pme.resources.ResourceFolderInfo¶
呼び出し時点で観測した登録フォルダー。リソースフォルダーとアイコン用フォルダーの両方に使います。
属性
型
値
indexint
登録順の位置(0 から)。安定した識別子ではありません。
namestr
リソースフォルダーの表示名。アイコン用フォルダーでは
""。 名前空間でも安定した識別子でもありません。raw_pathstr
保存されたとおりのパス。
resolved_pathstr
絶対パス。相対の
raw_pathは、実行中の Blender 実行ファイルがあるディレクトリを基準に解決します。~と環境変数は展開します。statusがinvalidの場合は""。statusstr
フォルダーの状態 を参照。
フォルダーの状態
status意味
availableディレクトリを開いて一覧を取得できます。配下は確認しないため、 読めないものが含まれる場合があります。
missing登録された場所が存在しません。
not_directoryその場所はディレクトリではありません。
unreadableその場所を確認または走査できません。
invalid保存されたパスを解決できません。
resolved_pathは""です。
ファイル¶
- pme.resources.list_files(kind=None)¶
登録フォルダー内に存在するスクリプトとアイコンのファイルを列挙します。 どのスロットも使っていないファイルも含みます。
呼び出しのたびに、有効なリソース設定とファイルシステムを読み直します。
- パラメータ:
kind (str or None) -- 両方の種類なら
None、または"script"、"icon"。- 戻り値:
見つかったファイルと、読めなかった場所。
- 戻り値の型:
- 例外:
ValueError --
kindがそれ以外の値の場合。メッセージは"kind must be None, 'script', or 'icon'"。RuntimeError -- リソース設定を読めず、以前の有効な設定もない場合。 メッセージは
"Resource settings are unavailable"。
走査範囲
種類
列挙するファイル
スクリプト
各リソースフォルダー内のどこかにある、小文字の
.pyで終わるファイル。相対のスクリプト参照はフォルダー自体を基準に解決するため、scripts/の外も含みます。名前が.で始まるフォルダーと__pycache__は飛ばします。ディレクトリのシンボリックリンクはたどります。各実ディレクトリは、登録フォルダーごとに一度だけ走査します。アイコン
各アイコン用フォルダーの直下にある、小文字の
.pngで終わるファイル。予約された接頭辞_intr_を持つ名前は除きます。名前が衝突するファイルと、_で始まる名前(Custom の選択一覧では非表示)も含みます。選択や描画ができると確認したアイコンの一覧ではありません。例
登録フォルダーとファイルを、ほかのツールに渡す JSON にまとめます。
from dataclasses import asdict import json import pme folders = pme.resources.list_folders() listing = pme.resources.list_files() payload = { "folders": [asdict(folder) for folder in folders], "files": [asdict(item) for item in listing.files], "issues": [asdict(issue) for issue in listing.issues], } print(json.dumps(payload, ensure_ascii=False, indent=2))
補足
filesが完全な一覧になるのは、issuesが空のときだけです。availableでないフォルダーは、問題を一つ加え、ファイルは加えません。 走査中に失敗したパスは問題を加えます。そのフォルダーの残りは引き続き列挙します。存在しない登録済みのリソースフォルダーやアイコン用フォルダーは、問題になります。
kind=Noneでは、スクリプトが先、アイコンが後です。フォルダーは登録順で、名前は各ディレクトリ内で並べ替えます。異なるフォルダーにある同じ名前のファイルは、別のエントリです。
ファイルの内容は実行もデコードもしません。
外部エディターによるリソース設定ファイルの変更は、次の起動時、またはアドオンを再度有効にしたときに読み込みます。
- class pme.resources.ResourceFileListing¶
list_files()の結果。属性
型
値
filestuple[ResourceFileInfo, ...]
見つかったファイル。
issuestuple[ResourcePathIssue, ...]
読めなかったフォルダーとパス。
- class pme.resources.ResourceFileInfo¶
存在するスクリプトまたはアイコンのファイル。
属性
型
値
folderResourceFolderInfo
ファイルを含む登録フォルダー。走査時点の状態を持ちます。
kindstr
"script"または"icon"。relative_pathstr
folderからの相対パス。区切りは/です。スクリプトではscripts/modeling/align.pyなど、アイコンではname.pngなどのファイル名です。スクリプトの場合は検索用の参照です。ほかの登録フォルダーが同じ参照でファイルを持つ場合があり、resolve_script()がそれを報告します。absolute_pathstr
ファイルの絶対パス。
- class pme.resources.ResourcePathIssue¶
読めなかったフォルダーまたはパス。
属性
型
値
folderResourceFolderInfo
対象の登録フォルダー。
pathstr
利用できないフォルダーでは、そのフォルダーの
resolved_path(空の場合はraw_path)。それ以外では、走査中に失敗したパス。 例外のテキストは含みません。codestr
missing、not_directory、unreadable、invalidのいずれか。意味は フォルダーの状態 と同じです。
スクリプト参照¶
- pme.resources.resolve_script(reference)¶
スクリプト実行が使うリゾルバーでスクリプト参照を解決します。スクリプトは実行しません。
スロットは、登録フォルダー内のファイルのパスを、そのフォルダーからの相対パスで保存します。例:
scripts/modeling/align.py。解決した絶対パスは、 現時点で見つかったファイルを示します。- パラメータ:
reference (str) -- 絶対パスまたは相対参照。
- 戻り値:
解決の状態と、該当するファイル。
- 戻り値の型:
検索順
reference確認する場所
絶対パス
そのパスだけ。
assets/examples/scripts/...アドオンパッケージ内の同梱サンプルだけ。
それ以外の相対参照
すべての登録リソースフォルダー。
\は/として読みます。 アドオンパッケージを確認するのは、どの登録フォルダーにも候補がなく、すべての登録場所を確認できた場合だけです。パッケージ内では、scripts/...の参照で、以前の場所にある同梱サンプルも見つけます。ステータス
status意味
resolvedファイルが一つ見つかりました。読み取り権限と Python の構文は確認しません。
missing該当するファイルが見つかりません。
ambiguous異なる二つ以上のファイルが該当します。
unavailable場所を解決または確認できず、解決を完了できませんでした。
例
スロット用のコマンド文字列を作ります。スクリプトの実行もスロットの編集もしません。
import pme reference = "scripts/modeling/align.py" result = pme.resources.resolve_script(reference) if result.status == "resolved": command = f"execute_script({reference!r})" print(command) # execute_script('scripts/modeling/align.py') else: print(result.status, result.candidates)
補足
異なるファイルは、内容が同じでも別の候補です。同じ実ファイルに至るパスは一つの候補として数えます。
ambiguousはunavailableより優先します。呼び出しの後にファイルが変わる場合があります。スクリプト実行時には参照を解決し直します。
- class pme.resources.ScriptResolution¶
resolve_script()の結果。属性
型
値
referencestr
引数
referenceの値。statusstr
resolved、missing、ambiguous、unavailableのいずれか。resolved_pathstr or None
statusがresolvedのときはファイルの絶対パス。それ以外はNone。candidatestuple[str, ...]
見つかった該当ファイルのパス。
resolvedでは一つ、ambiguousでは二つ以上、missingでは空、unavailableでは確認できたもの。
対象範囲¶
これらの関数は、スクリプトの実行、画像のデコード、ディレクトリの作成、 設定の移行を行いません。
どのスロットがファイルを使っているかは報告しません。ファイルを移動・改名しても、スロットの参照は更新しません。