Context Router¶
Context Router(mode ID ROUTER)は、順序付きの分岐の一覧と Otherwise を持ちます。
これらの関数は、その保存されたロジックを分岐の UID で読み取り、変更します。
メニューの作成は pme.create_pm() (メニュー)、ホットキーは
ホットキー、エディターは Context Router Editor で説明します。
関数 |
用途 |
|---|---|
保存されたロジックと digest を |
|
分岐を UID で変更し、分岐を追加し、Otherwise を変更します。 |
|
分岐を 1 つ削除します。 |
|
分岐を 1 つ、別の分岐の前または後ろへ移動します。 |
|
すべての分岐を指定した順序に並べます。 |
関連項目: Router の分岐を追加して条件を編集する。
Router を読み取る¶
Router では、read_pm(pm_uid) は router も返します。
キー |
型 |
値 |
|---|---|---|
|
dict or None |
保存されたロジック。Router のロジック で説明します。
保存されたロジックを読み取れないときは |
|
str |
保存されたロジックのテキストの SHA-256 16 進 digest。このページの関数に
|
|
list[dict] |
保存されたロジックを読み取れるときは空です。それ以外では問題ごとに 1 要素で、
それぞれ |
新しい Router には分岐がなく、Otherwise は Pass Through に設定されています。
>>> pme.editing.read_pm(router_uid)["router"]
{'logic': {'version': 2, 'branches': [],
'otherwise': {'name': 'Otherwise',
'target': {'action': None, 'fallback_name': ''},
'pass': True}},
'digest': 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855',
'diagnostics': []}
返される辞書はコピーです。変更しても Router は変わりません。
新しい Router には、まだ保存されたロジックのテキストがありません。その digest は空のテキストの digest です。
上のロジックと等しい要求は unchanged を返し、テキストは空のままです。
ロジックを変える書き込みはテキストを保存し、digest を変えます。次の編集の前に読み直してください。
関数¶
- pme.editing.update_router(pm_uid, *, branches=(), otherwise=None, expected_digest=None, dry_run=False)¶
分岐を UID で変更し、分岐を追加し、Otherwise を変更します。
呼び出しで指定していない分岐も含め、結果のロジック全体を書き込みの前に検査します。 1 つでも規則に反すれば、何も保存しません。
- パラメータ:
pm_uid (str) -- Router の UID。
branches (list or tuple of dict) -- 分岐のパッチ。パッチの規則 のとおりに適用されます。
otherwise (dict or None) -- 置き換える Otherwise の項目。
Noneなら Otherwise を保持します。expected_digest (str or None) --
read_pm()["router"]の digest。異なる場合、呼び出しはstale_router_digestで拒否されます。dry_run (bool) -- 要求を検査し、書き込まずに候補を返します。
- 戻り値:
共通の結果キー で説明する結果。
- 戻り値の型:
- 例外:
RuntimeError -- Blender のメインスレッド以外から、または PME の読み込みが完了する前に呼ばれた。
パッチの規則
入力
影響
branch_uidを持つ要素その分岐を更新します。UID はこの Router の分岐を指す必要があります。 1 回の呼び出しで、同じ UID は 1 回だけ使えます。
branch_uidを持たない要素新しい UID を持つ新しい分岐を末尾に追加します。要素はリストの順に追加されます。
要素で省略した項目
保存値を保持します。新しい分岐では下の既定値を使います。
name、enabled、combine_mode、targetの指定保存値を置き換えます。
targetは全体が置き換わります。conditionsの指定分岐の条件の一覧全体を置き換えます。
condition_uidを持つ行はその UID を保ちます。持たない行には、呼び出し前にその分岐にあったどの行の UID とも異なる、 新しい UID が割り当てられます。行の
enabled、authoring_state、labelの省略True、"complete"、""。指定しない分岐
位置を含めて変わりません。
otherwiseの省略またはNone変わりません。
otherwiseの指定指定したキー (
name、target、pass) だけを置き換えます。targetは全体が置き換わります。新しい分岐の初期値は、
nameが"Branch <n>"(nは追加後の分岐の数)、enabledがTrue、combine_modeが"all"、条件なし、targetが{"action": None, "fallback_name": ""}です。ステータス
committed、validated、unchanged、rejected、unknownのいずれか。 結果のロジックが保存されたロジックと等しい要求は、新しい Router でも、書き込まずにunchangedを返します。dry_run=Trueでは、同じ要求がvalidatedを返します。診断
共通のコード に加えて、次のコードを返します。
code原因と追加のキー
branches_must_be_a_sequencebranchesが list でも tuple でもありません。pathは"branches"です。otherwise_must_be_a_mappingotherwiseが dict でもNoneでもありません。router_input_must_be_json_valuesJSON に変換できない値があります: JSON 以外の型、循環参照、NaN、 無限大。
branch_must_be_a_mappingbranchesの要素が dict ではありません。pathは"branches[<i>]"です。branch_uid_invalidbranch_uidが空でない文字列ではありません。branch_not_foundbranch_uidがこの Router のどの分岐も指していません。duplicate_branch_edit2 つの要素が同じ
branch_uidを指定しています。conditions_must_be_a_sequenceconditionsが list でも tuple でもありません。condition_must_be_a_mapping条件行が dict ではありません。
pathは"branches[<i>].conditions[<j>]"です。例
既存の Router の No Match を Pass Through にします。
before = pme.editing.read_pm(router_uid)["router"] result = pme.editing.update_router( router_uid, otherwise={"pass": True}, expected_digest=before["digest"], ) assert result["status"] == "committed", result["diagnostics"]
補足
呼び出し元の辞書は変更しません。
validatedの候補に含まれる新しい UID は仮の値です。プレビューした内容を保存するには、 同じbranchesとotherwiseをdry_run=Falseで渡し直します。 候補で新たに割り当てられた分岐の UID を、既存の分岐として渡さないでください。分岐の UID は 1 つの Router 内で一意です。
remove_router_branch()で空いた UID は、後の新しい分岐に割り当てられることがあります。router_target_menu_unresolvedの警告は、validatedやcommittedと一緒に返ることがあります。この呼び出しは、条件の評価、対象の実行、選択中のメニューやエディターの下書きの変更、 Preferences のディスクへの保存、Undo ステップの追加を行いません。
- pme.editing.remove_router_branch(pm_uid, branch_uid, *, expected_digest=None, dry_run=False)¶
分岐を 1 つ削除します。
- パラメータ:
- 戻り値:
共通の結果キー で説明する結果。
- 戻り値の型:
- 例外:
RuntimeError -- Blender のメインスレッド以外から、または PME の読み込みが完了する前に呼ばれた。
ステータス
committed、validated、rejected、unknownのいずれか。診断
共通のコード に加えて、次のコードを返します。
code原因と追加のキー
branch_uid_invalidbranch_uidが空でない文字列ではありません。branch_not_foundbranch_uidがこの Router のどの分岐も指していません。branch_identity_ambiguous保存された 2 つの分岐が同じ UID を持っています。
例
router = pme.editing.read_pm(router_uid)["router"] result = pme.editing.remove_router_branch( router_uid, router["logic"]["branches"][-1]["branch_uid"], expected_digest=router["digest"], ) assert result["status"] == "committed", result["diagnostics"]
補足
最後に残った分岐も削除できます。
ほかの分岐、その条件の UID、Otherwise は保持されます。
この呼び出しは、対象の実行、選択中のメニューやエディターの下書きの変更、 Preferences のディスクへの保存、Undo ステップの追加を行いません。
- pme.editing.move_router_branch(pm_uid, branch_uid, *, before_uid=None, after_uid=None, expected_digest=None, dry_run=False)¶
分岐を 1 つ、同じ Router の別の分岐の直前または直後へ移動します。
- パラメータ:
- 戻り値:
共通の結果キー で説明する結果。
- 戻り値の型:
- 例外:
RuntimeError -- Blender のメインスレッド以外から、または PME の読み込みが完了する前に呼ばれた。
ステータス
committed、validated、unchanged、rejected、unknownのいずれか。 現在の位置 (branch_uidと等しい基準を含む) は、書き込まずにunchangedを返します。dry_run=Trueでは、同じ要求がvalidatedを返します。診断
共通のコード に加えて、次のコードを返します。
code原因と追加のキー
branch_uid_invalidbranch_uidが空でない文字列ではありません。branch_not_foundbranch_uidがこの Router のどの分岐も指していません。branch_identity_ambiguous保存された 2 つの分岐が同じ UID を持っています。
exactly_one_branch_anchor_requiredbefore_uidとafter_uidの両方が指定された、またはどちらも指定されていません。branch_anchor_uid_invalid基準が空でない文字列ではありません。
branch_anchor_not_found基準がこの Router のどの分岐も指していません。
例
最後の分岐の優先度を最も高くします。
snapshot = pme.editing.read_pm(router_uid)["router"] branches = snapshot["logic"]["branches"] result = pme.editing.move_router_branch( router_uid, branches[-1]["branch_uid"], before_uid=branches[0]["branch_uid"], expected_digest=snapshot["digest"], ) print(result["status"], result["diagnostics"])
補足
分岐の内容、条件の UID、Otherwise は保持されます。
書き込み後に digest は変わります。次の編集の前に読み直してください。
エディターの Branch メニューの Move Up、Move Down、Remove Branch も、 同じ分岐の規則に従います。エディターからの保存では、ほかの保存値にもエディター自身の正規化が適用されます。
この呼び出しは、対象の実行、選択中のメニューやエディターの下書きの変更、 Preferences のディスクへの保存、Undo ステップの追加を行いません。
- pme.editing.reorder_router_branches(pm_uid, branch_uids, *, expected_digest=None, dry_run=False)¶
1 回の書き込みで、すべての分岐を指定した順序に並べます。
- パラメータ:
- 戻り値:
共通の結果キー で説明する結果。
- 戻り値の型:
- 例外:
RuntimeError -- Blender のメインスレッド以外から、または PME の読み込みが完了する前に呼ばれた。
ステータス
committed、validated、unchanged、rejected、unknownのいずれか。 現在の順序は、書き込まずにunchangedを返します。dry_run=Trueでは、同じ要求がvalidatedを返します。診断
共通のコード に加えて、次のコードを返します。
code原因と追加のキー
branch_uids_must_be_a_sequencebranch_uidsが文字列、bytes、または iterable ではありません。pathは"branch_uids"です。branch_uids_must_be_orderedbranch_uidsがset、frozensetなどの集合型で、 順序が定まりません。received_typeがその型を示します。dry_run=Trueでも返ります。branch_uids_must_list_every_branch_once一覧が一部だけ、UID が重複している、または分岐の UID ではない値を含みます。
missingは指定されなかった分岐の UID、unknownは分岐の UID ではない指定値を列挙します。branch_identity_ambiguous保存された 2 つの分岐が同じ UID を持っています。
pathは"logic.branches"です。例
router = pme.editing.read_pm(router_uid)["router"] order = [branch["branch_uid"] for branch in router["logic"]["branches"]] result = pme.editing.reorder_router_branches( router_uid, list(reversed(order)), expected_digest=router["digest"], ) assert result["status"] == "committed", result["diagnostics"]
補足
分岐の内容、その UID、Otherwise は保持されます。
この呼び出しは、対象の実行、Preferences のディスクへの保存、Undo ステップの追加を行いません。