:vocab: developer-facing .. _authoring-export-validate: ============================================================ 書き出しと検証 ============================================================ .. py:currentmodule:: pme :py:func:`export_menus` は、メニューを PME の JSON 文書として書き出します。 検証関数は、文書を変更も実行もせずに、同梱の JSON Schema v2 と PME の UID 規則に照らして検査します。 .. list-table:: :header-rows: 1 :widths: 40 60 * - 関数 - 用途 * - :py:func:`export_menus` - メニューを JSON 文書として書き出します。指定すればファイルにも書き込みます。 * - :py:func:`validate_json` - JSON 文字列を検証します。 :py:class:`~pme.validation.ValidationResult` を返します。 * - :py:func:`pme.validation.validate` - 解析済みの JSON データを検証します。 * - :py:func:`pme.validation.validate_file` - UTF-8 の JSON ファイルを検証します。 * - :py:func:`validate_uid` - メニュー UID の形式を確認します。:ref:`authoring-execution` で説明しています。 メニューを書き出す ============================================================ .. py:function:: export_menus(pm_uids=None, *, include_referenced_menus=True, export_tags=True, filepath=None) メニューを PME の JSON 文書として書き出します。 書き出し処理とファイルの書き込みには、**Export Menus** ダイアログと同じものを使います。選択中のメニュー、Select Mode、一覧のフィルターは読まず、 変更もしません。 :param pm_uids: 書き出すメニューの UID。文字列以外の iterable で渡します。 ``None`` はすべてのメニューを書き出します。 :type pm_uids: iterable of str or None :param bool include_referenced_menus: 指定したメニューが参照するメニューも書き出します。:ref:`authoring-export-closure` を参照。``pm_uids`` が ``None`` の場合は効果がありません。 :param bool export_tags: タグ名、タグ UID、タグレジストリを含めます。 :param filepath: JSON テキストを書き込むファイル。パスが ``.json`` で終わらない場合は ``.json`` を付けます(大文字と小文字を区別)。既存のファイルは置き換えます。 :type filepath: str or None :returns: 下記の結果。 :rtype: dict :raises TypeError: ``pm_uids`` が文字列、bytes、または iterable でない場合、``include_referenced_menus`` または ``export_tags`` が bool でない場合、``filepath`` が空でない文字列ではない場合。 :raises ValueError: ``pm_uids`` が空の場合、その中の UID が拒否された場合、またはデータを書き出せない場合。*エラー* を参照。 :raises RuntimeError: Blender のメインスレッド以外から呼び出された場合 (``"Menu export requires Blender's main thread"``)、PME が起動スクリプトを実行している間に呼び出された場合 (``"Menu export requires PME to finish loading"``)、 :py:data:`preferences` が ``None`` の間に呼び出された場合 (``"PME preferences are unavailable"``)。 :raises KeyError: :py:data:`preferences` と同じく、:py:data:`ADDON_ID` が ``bpy.context.preferences.addons`` にない場合。 :raises OSError: ファイルを書き込めない場合。例: ディレクトリが存在しない場合の ``FileNotFoundError``。 .. rubric:: 結果 .. list-table:: :header-rows: 1 :widths: 22 16 62 * - キー - 型 - 値 * - ``data`` - dict - 文書。:ref:`authoring-export-document` を参照。 * - ``text`` - str - ファイルに書き込むものと同一の、``data`` の JSON テキスト。 * - ``pm_uids`` - list[str] - 書き出したメニューの UID。文書内の順序です。 * - ``warnings`` - list[str] - 書き出しを止めなかった問題。*警告* を参照。 * - ``filepath`` - str or None - 書き込んだファイルのパス。付け足した ``.json`` を含みます。 ``filepath`` を指定しなかった場合は ``None``。 .. rubric:: エラー どのエラーも ``ValueError`` です。``pm_uids`` の確認は指定順に行い、 最初に失敗した UID を示します。 .. list-table:: :header-rows: 1 :widths: 50 50 * - メッセージ - 原因 * - ``pm_uids must name at least one menu; pass None to export all`` - ``pm_uids`` が空です。 * - ``Menu UID is invalid: `` - :py:func:`validate_uid` が受け付ける形式のメニュー UID ではありません。UID は ``repr()`` で表示します。 * - ``Menu UID is listed more than once in pm_uids: `` - ``pm_uids`` に同じ UID が 2 回現れます。 * - ``Menu UID is missing: `` - その UID を持つ保存済みメニューがありません。 * - ``Menu UID is ambiguous: saved menus share `` - 複数の保存済みメニューがその UID を持ちます。 * - ``PME: Context Router logic export failed for menu '': refers to , which is outside the exported menu set`` - Context Router の分岐先メニューが書き出されません。```` は ``branch '