Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions plugins/ndf/bin/ndf
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,11 @@
# 入れられない(curl が無い・ネットワークが無い・ハッシュが違うなど)ときは、理由を結果 JSON(stopped・deps_missing)で出し、
# 終了コードの表(contracts/facts/exit-codes.json)の deps_missing の終了コードで止まる。
#
# 呼び出し元の CLAUDE_PLUGIN_ROOT は、子へ自分の根を渡す前に NDF_CALLER_PLUGIN_ROOT へ写す。Python 側は
# それを読み、ほかのプラグインの根なら旧い状態の保存先を退避しない(identity.py)。
# 呼び出し元の CLAUDE_PLUGIN_ROOT は、子へ自分の根を渡す前に NDF_CALLER_PLUGIN_ROOT へ写す(無ければ空)。
# ほかに NDF と uv run が入れる UV_PROJECT_ENVIRONMENT・VIRTUAL_ENV・UV_RUN_RECURSION_DEPTH・PATH・PYTHONPATH は、
# 呼び出し元の値を NDF_CALLER_<名前> へ写す(あれば空でも写し、無ければ写しを消す。外側の ndf の写しを残さない)。
# start.py は `python -m ndf` の前に、写しから呼び出し元の値へ戻す。NDF の子孫が利用先で打つ uv run が NDF の venv を
# 書き換えない(#4029)。子が `ndf` を打てば、このファイルが毎回 NDF の venv を指し直す。
set -euo pipefail

UV_VERSION="0.13.7"
Expand Down Expand Up @@ -84,6 +87,9 @@ if got != want:
fi

export NDF_CALLER_PLUGIN_ROOT="${CLAUDE_PLUGIN_ROOT:-}"
for held in UV_PROJECT_ENVIRONMENT VIRTUAL_ENV UV_RUN_RECURSION_DEPTH PATH PYTHONPATH; do
if [ -n "${!held+set}" ]; then export "NDF_CALLER_$held=${!held}"; else unset "NDF_CALLER_$held"; fi
done
export CLAUDE_PLUGIN_ROOT="$root"
export UV_PROJECT_ENVIRONMENT="$cache_home/venv/$version"
export PYTHONPATH="$root/src${PYTHONPATH:+:$PYTHONPATH}"
Expand Down
32 changes: 32 additions & 0 deletions plugins/ndf/bin/start.py
Comment thread
takemi-ohama marked this conversation as resolved.
Resolved
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,22 @@

確かめるのは、確かめたマーカー(環境の中の `.deps-checked`)が無いか、`uv.lock` より古いときだけにする(ふだんの起動はマーカーの
更新時刻を見るだけ)。標準ライブラリだけを読む(依存が欠けていても動く)。

自分のパッケージを呼ぶ前に、エントリポイントと uv run が入れた環境の変数を、エントリポイントが写した呼び出し元の値へ戻す
(`CALLER_ENV`。#4029)。NDF の子孫(プランのステップ・レーンのセッション・cross-review の相手役など)が利用先のリポジトリで
uv run を打っても、NDF の venv を書き換えない。自分の import の道(sys.path)は起動のときに決まっているので変わらない。
NDF が自分のパッケージを子で打つときは `ndf.cli` の `ndf_command` で src を子の sys.path にだけ渡す。写しの変数は
消す(呼び出し元の `CLAUDE_PLUGIN_ROOT` は戻した値として identity.py が読む)。
"""

from __future__ import annotations

import csv
import json
import os
import runpy
import sys
from collections.abc import MutableMapping
from importlib import metadata
from pathlib import Path

Expand All @@ -24,6 +32,17 @@
STAMP = Path(sys.prefix) / ".deps-checked"
# 入れる手段によって作られないことがあるファイル(RECORD に載っても欠けを数えない)
OPTIONAL_SUFFIXES = (".pyc",)
# エントリポイントと uv run が入れる変数と、エントリポイントが呼び出し元の値を写す変数(無かった値は写しを持たない)
CALLER_ENV = {
"CLAUDE_PLUGIN_ROOT": "NDF_CALLER_PLUGIN_ROOT",
"UV_PROJECT_ENVIRONMENT": "NDF_CALLER_UV_PROJECT_ENVIRONMENT",
"VIRTUAL_ENV": "NDF_CALLER_VIRTUAL_ENV",
"UV_RUN_RECURSION_DEPTH": "NDF_CALLER_UV_RUN_RECURSION_DEPTH",
"PATH": "NDF_CALLER_PATH",
"PYTHONPATH": "NDF_CALLER_PYTHONPATH",
}
# 写しの空の値を「無かった」と読む変数(エントリポイントが無いときも空で写す)
EMPTY_IS_UNSET = frozenset({"CLAUDE_PLUGIN_ROOT"})


def recorded_files(dist) -> list[str]:
Expand Down Expand Up @@ -72,6 +91,18 @@ def emit_deps_missing(detail: str) -> int:
return next(row["code"] for row in rows if row["id"] == "deps_missing")


def restore_caller_env(env: MutableMapping[str, str]) -> None:
"""`env` を写しの呼び出し元の値へ戻し、写しの変数を消す。写しが 1 つも無ければ(エントリポイントを通らずに打った)何もしない。"""
if not any(held in env for held in CALLER_ENV.values()):
return
for name, held in CALLER_ENV.items():
value = env.pop(held, None)
if value is None or (not value and name in EMPTY_IS_UNSET):
env.pop(name, None)
else:
env[name] = value


def main() -> int:
if not checked():
broken = broken_distributions()
Expand All @@ -81,6 +112,7 @@ def main() -> int:
STAMP.touch()
except OSError: # noqa: NDF401 ファイル: マーカーを書けない環境は、次の起動でも確かめる
pass
restore_caller_env(os.environ)
runpy.run_module(PACKAGE, run_name="__main__", alter_sys=True)
return 0

Expand Down
7 changes: 6 additions & 1 deletion plugins/ndf/contracts/domains/env.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,12 @@
{"id": "UV_PROJECT_ENVIRONMENT", "area": "identity", "set_by": "ndf", "type": "path", "secret": false, "meaning": "bin/ndf が NDF の依存の環境(<キャッシュ>/ndf/venv/<バージョン>)を指して uv へ渡す。中継が起動するセッションへ渡すと、セッションの中の uv run が NDF の環境を書き換えるため渡さない", "child": "drop"},
{"id": "VIRTUAL_ENV", "area": "identity", "set_by": "runtime", "type": "path", "secret": false, "meaning": "uv run が NDF の依存の環境を指して入れる。中継が起動するセッションへ渡すと、セッションの中の uv と python が NDF の環境を使うため渡さない", "child": "drop"},
{"id": "UV_RUN_RECURSION_DEPTH", "area": "identity", "set_by": "runtime", "type": "integer", "secret": false, "meaning": "uv run が入れ子の深さとして入れる。中継が起動するセッションへ渡すと、セッションの中の uv run の深さを誤って数えるため渡さない", "child": "drop"},
{"id": "NDF_CALLER_PLUGIN_ROOT", "area": "identity", "set_by": "ndf", "type": "path", "secret": false, "meaning": "bin/ndf が子へ自分の根を渡す前に写した、呼び出し元の CLAUDE_PLUGIN_ROOT(空なら無かった)。ほかのプラグインの根なら旧い状態の保存先を退避しない。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_CALLER_PLUGIN_ROOT", "area": "identity", "set_by": "ndf", "type": "path", "secret": false, "meaning": "bin/ndf が子へ自分の根を渡す前に写した、呼び出し元の CLAUDE_PLUGIN_ROOT(空なら無かった)。bin/start.py が自分のパッケージを呼ぶ前に CLAUDE_PLUGIN_ROOT へ戻して消す(#4029)。残っていれば(bin/ndf を通らずに打った子)ほかのプラグインの根のとき旧い状態の保存先を退避しない。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_CALLER_UV_PROJECT_ENVIRONMENT", "area": "identity", "set_by": "ndf", "type": "path", "secret": false, "meaning": "bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の UV_PROJECT_ENVIRONMENT(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_CALLER_VIRTUAL_ENV", "area": "identity", "set_by": "ndf", "type": "path", "secret": false, "meaning": "bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の VIRTUAL_ENV(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_CALLER_UV_RUN_RECURSION_DEPTH", "area": "identity", "set_by": "ndf", "type": "integer", "secret": false, "meaning": "bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の UV_RUN_RECURSION_DEPTH(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_CALLER_PATH", "area": "identity", "set_by": "ndf", "type": "string", "secret": false, "meaning": "bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の PATH(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_CALLER_PYTHONPATH", "area": "identity", "set_by": "ndf", "type": "string", "secret": false, "meaning": "bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の PYTHONPATH(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない", "child": "drop"},
{"id": "NDF_STATE_HOME", "area": "identity", "set_by": "user", "type": "path", "secret": false, "meaning": "状態の保存先の根。保存先は <値>/<プラグイン名>(XDG_STATE_HOME と同じ読み方。入れ替えの前に旧い NDF と同じ値を渡されても、旧い保存先を退避しない)。無ければ XDG_STATE_HOME の下"},
{"id": "XDG_STATE_HOME", "area": "identity", "set_by": "user", "type": "path", "secret": false, "meaning": "XDG の状態の保存先。無ければ ~/.local/state"},
{"id": "CLAUDECODE", "area": "runtime", "set_by": "runtime", "type": "flag", "secret": false, "meaning": "Claude Code の中で動いているマーカー(ホストの推定)。中継が起動するセッションへ渡さない(残ると claude が入れ子の起動を断る)", "child": "drop"},
Expand Down
7 changes: 6 additions & 1 deletion plugins/ndf/docs/contracts/env.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,12 @@ NDF が読む環境変数と、NDF が子のプロセスへ渡す環境変数で
| `NDF_ACCOUNTS_DIR` | user | path | — | アカウントの登録の保存先(ndf relay account の登録のサブコマンド)。無ければ <共有の設定ディレクトリ>/ndf/accounts(旧いプラグインと同じ保存先) | 内部(予告なく変えてよい) |
| `NDF_API_KEY_CHECK_MODEL` | user | string | — | API キーの確かめに使うモデル。無ければ claude-haiku-4-5 | 内部(予告なく変えてよい) |
| `NDF_API_KEY_CHECK_URL` | user | string | — | API キーの確かめの送信先。無ければ https://api.anthropic.com/v1/messages | 内部(予告なく変えてよい) |
| `NDF_CALLER_PLUGIN_ROOT` | ndf | path | — | bin/ndf が子へ自分の根を渡す前に写した、呼び出し元の CLAUDE_PLUGIN_ROOT(空なら無かった)。ほかのプラグインの根なら旧い状態の保存先を退避しない。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CALLER_PATH` | ndf | string | — | bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の PATH(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CALLER_PLUGIN_ROOT` | ndf | path | — | bin/ndf が子へ自分の根を渡す前に写した、呼び出し元の CLAUDE_PLUGIN_ROOT(空なら無かった)。bin/start.py が自分のパッケージを呼ぶ前に CLAUDE_PLUGIN_ROOT へ戻して消す(#4029)。残っていれば(bin/ndf を通らずに打った子)ほかのプラグインの根のとき旧い状態の保存先を退避しない。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CALLER_PYTHONPATH` | ndf | string | — | bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の PYTHONPATH(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CALLER_UV_PROJECT_ENVIRONMENT` | ndf | path | — | bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の UV_PROJECT_ENVIRONMENT(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CALLER_UV_RUN_RECURSION_DEPTH` | ndf | integer | — | bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の UV_RUN_RECURSION_DEPTH(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CALLER_VIRTUAL_ENV` | ndf | path | — | bin/ndf が子へ自分の値を入れる前に写した、呼び出し元の VIRTUAL_ENV(無ければ写しを持たない)。bin/start.py が自分のパッケージを呼ぶ前に呼び出し元の値へ戻して消す(#4029)。中継が起動するセッションへ渡さない | 内部(予告なく変えてよい) |
| `NDF_CLAUDE_ACCOUNT` | user | string | — | 子の claude を起動する登録済みのアカウントの名前 | 内部(予告なく変えてよい) |
| `NDF_CLAUDE_API_KEY_GENERATION` | ndf | integer | — | 子へ渡した API キーの世代。入れ子の監督が読む | 内部(予告なく変えてよい) |
| `NDF_CLAUDE_API_KEY_NAME` | ndf | string | — | 子へ渡した API キーの名前。入れ子の監督が読む | 内部(予告なく変えてよい) |
Expand Down
2 changes: 1 addition & 1 deletion plugins/ndf/docs/contracts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ NDF を外から呼ぶ面(設定・サブコマンド・環境変数・受け
| [設定(.ndf/)](ndf-settings.md) | 公開 18・内部 1 |
| [サブコマンドの引数と結果](commands.md) | 公開 0・内部 28 |
| [終了コードと停止理由](exit-codes.md) | 終了コード 11・停止理由 33 |
| [環境変数](env.md) | 公開 10・内部 55 |
| [環境変数](env.md) | 公開 10・内部 60 |
| [受け渡しのファイル](files.md) | 公開 12・内部 56 |
| [hook の入出力](hooks.md) | 公開 6・内部 11 |
| [Skill と起動スクリプト](skills.md) | 公開 1・内部 48 |
Expand Down
Loading