py-opencode-wrapper 0.2.0__tar.gz → 0.2.2__tar.gz

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py-opencode-wrapper
-Version: 0.2.0
+Version: 0.2.2
 Summary: Async Python wrapper for OpenCode CLI (opencode run --format json)
 Project-URL: Homepage, https://github.com/idailylife/oc_py_wrapper
 Project-URL: Repository, https://github.com/idailylife/oc_py_wrapper
@@ -61,6 +61,12 @@ async def main():
 asyncio.run(main())
 ```
 
+Set `RunConfig(record_thinking=True)` when you want OpenCode reasoning/thinking
+parts included in `result.events` and `log_file` JSON lines. This only maps to
+OpenCode's display/output flag `--thinking`; it does not change model reasoning
+effort. Use `variant` separately if you intentionally want a provider-specific
+reasoning effort.
+
 ### Stream structured JSON events
 
 ```python
@@ -104,11 +110,29 @@ Per-call JSON is merged and passed as `OPENCODE_CONFIG_CONTENT` (see [OpenCode c
 | `permission` | `permission` map (`allow` / `deny`, patterns) |
 | `mcp` | MCP server definitions |
 | `tools` | Enable/disable tools (including MCP globs) |
+| `instructions` | Instruction file paths / glob patterns to inject |
 | `config_overrides` | Any extra top-level config keys to deep-merge |
 
 Optional env tuning: `disable_autoupdate=True` sets `OPENCODE_DISABLE_AUTOUPDATE=1`.
 Note: `ask` is intentionally rejected in subprocess mode (no interactive terminal); use `allow` or `deny`.
 
+### User config isolation
+
+By default, `RunConfig.inherit_user_config=False` makes each child `opencode`
+process see a sanitized copy of the host's global OpenCode config. The wrapper
+keeps only provider-selection keys (`$schema`, `provider`,
+`disabled_providers`, `enabled_providers`) and drops capability/configuration
+keys such as `mcp`, `agent`, `command`, `tools`, `plugin`, `skills`,
+`instructions`, `permission`, and `model`.
+
+This keeps benchmark and orchestration runs reproducible while still allowing
+provider configuration and `opencode auth` credentials to work. Project-level
+config discovered from the workspace is not suppressed.
+
+Set `inherit_user_config=True` to restore the legacy behavior of inheriting the
+host OpenCode config as-is. For reproducible runs, pass `model`, `permission`,
+`mcp`, `tools`, and `instructions` explicitly through `RunConfig`.
+
 ## CLI arguments
 
 `RunConfig` maps to flags such as `--agent`, `-m`, `-f`, `--attach`, `--title`, etc. Prompt text is appended as the final `opencode run` message argument.

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/README.md

@@ -48,6 +48,12 @@ async def main():
 asyncio.run(main())
 ```
 
+Set `RunConfig(record_thinking=True)` when you want OpenCode reasoning/thinking
+parts included in `result.events` and `log_file` JSON lines. This only maps to
+OpenCode's display/output flag `--thinking`; it does not change model reasoning
+effort. Use `variant` separately if you intentionally want a provider-specific
+reasoning effort.
+
 ### Stream structured JSON events
 
 ```python
@@ -91,11 +97,29 @@ Per-call JSON is merged and passed as `OPENCODE_CONFIG_CONTENT` (see [OpenCode c
 | `permission` | `permission` map (`allow` / `deny`, patterns) |
 | `mcp` | MCP server definitions |
 | `tools` | Enable/disable tools (including MCP globs) |
+| `instructions` | Instruction file paths / glob patterns to inject |
 | `config_overrides` | Any extra top-level config keys to deep-merge |
 
 Optional env tuning: `disable_autoupdate=True` sets `OPENCODE_DISABLE_AUTOUPDATE=1`.
 Note: `ask` is intentionally rejected in subprocess mode (no interactive terminal); use `allow` or `deny`.
 
+### User config isolation
+
+By default, `RunConfig.inherit_user_config=False` makes each child `opencode`
+process see a sanitized copy of the host's global OpenCode config. The wrapper
+keeps only provider-selection keys (`$schema`, `provider`,
+`disabled_providers`, `enabled_providers`) and drops capability/configuration
+keys such as `mcp`, `agent`, `command`, `tools`, `plugin`, `skills`,
+`instructions`, `permission`, and `model`.
+
+This keeps benchmark and orchestration runs reproducible while still allowing
+provider configuration and `opencode auth` credentials to work. Project-level
+config discovered from the workspace is not suppressed.
+
+Set `inherit_user_config=True` to restore the legacy behavior of inheriting the
+host OpenCode config as-is. For reproducible runs, pass `model`, `permission`,
+`mcp`, `tools`, and `instructions` explicitly through `RunConfig`.
+
 ## CLI arguments
 
 `RunConfig` maps to flags such as `--agent`, `-m`, `-f`, `--attach`, `--title`, etc. Prompt text is appended as the final `opencode run` message argument.

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/opencode_wrapper/client.py

@@ -73,7 +73,7 @@ def build_argv(
         cmd.extend(["--port", str(run_cfg.port)])
     if run_cfg.variant:
         cmd.extend(["--variant", run_cfg.variant])
-    if run_cfg.thinking is True:
+    if run_cfg.record_thinking is True or run_cfg.thinking is True:
         cmd.append("--thinking")
 
     if prompt:
@@ -81,7 +81,12 @@ def build_argv(
     return cmd
 
 
-def build_env(run_cfg: RunConfig, base: Mapping[str, str] | None = None) -> dict[str, str]:
+def build_env(
+    run_cfg: RunConfig,
+    base: Mapping[str, str] | None = None,
+    *,
+    cwd: str | Path | None = None,
+) -> dict[str, str]:
     env = dict(base if base is not None else os.environ)
     if run_cfg.extra_env:
         env.update(dict(run_cfg.extra_env))
@@ -90,6 +95,14 @@ def build_env(run_cfg: RunConfig, base: Mapping[str, str] | None = None) -> dict
         env["OPENCODE_CONFIG_CONTENT"] = content
     if run_cfg.disable_autoupdate:
         env["OPENCODE_DISABLE_AUTOUPDATE"] = "1"
+    # opencode's `run` cmd resolves the project root as
+    # `process.env.PWD ?? process.cwd()` (run.ts:276), and the bash builtin
+    # `pwd` reads $PWD too.  asyncio.create_subprocess_exec(cwd=...) only
+    # chdirs the child; it leaves PWD inherited from the parent shell, which
+    # makes opencode operate against the wrong directory.  Pin PWD to the
+    # resolved workspace so the child sees a consistent cwd.
+    if cwd is not None:
+        env["PWD"] = str(cwd)
     return env
 
 
@@ -380,8 +393,8 @@ class AsyncOpenCodeClient:
         validate_config_for_run(run_cfg)
         bin_path = self.resolved_binary()
         argv = build_argv(bin_path, prompt, run_cfg)
-        env = build_env(run_cfg)
         cwd = str(Path(workspace).expanduser().resolve())
+        env = build_env(run_cfg, cwd=cwd)
 
         events_acc: list[dict[str, Any]] = []
         raw_acc: list[str] = []
@@ -436,8 +449,8 @@ class AsyncOpenCodeClient:
             validate_config_for_run(run_cfg)
             bin_path = self.resolved_binary()
             argv = build_argv(bin_path, prompt, run_cfg)
-            env = build_env(run_cfg)
             cwd = str(Path(workspace).expanduser().resolve())
+            env = build_env(run_cfg, cwd=cwd)
 
             events_acc: list[dict[str, Any]] = []
             raw_acc: list[str] = []

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/opencode_wrapper/config.py

@@ -147,6 +147,10 @@ class RunConfig:
     remote_dir: str | None = None
     port: int | None = None
     variant: str | None = None
+    # Include OpenCode reasoning/thinking parts in the JSON event stream.
+    # This maps to `opencode run --thinking`; it does not set model reasoning effort.
+    record_thinking: bool | None = None
+    # Backward-compatible alias for record_thinking.
     thinking: bool | None = None
     print_logs: bool | None = None
     log_level: str | None = None

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/py_opencode_wrapper.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py-opencode-wrapper
-Version: 0.2.0
+Version: 0.2.2
 Summary: Async Python wrapper for OpenCode CLI (opencode run --format json)
 Project-URL: Homepage, https://github.com/idailylife/oc_py_wrapper
 Project-URL: Repository, https://github.com/idailylife/oc_py_wrapper
@@ -61,6 +61,12 @@ async def main():
 asyncio.run(main())
 ```
 
+Set `RunConfig(record_thinking=True)` when you want OpenCode reasoning/thinking
+parts included in `result.events` and `log_file` JSON lines. This only maps to
+OpenCode's display/output flag `--thinking`; it does not change model reasoning
+effort. Use `variant` separately if you intentionally want a provider-specific
+reasoning effort.
+
 ### Stream structured JSON events
 
 ```python
@@ -104,11 +110,29 @@ Per-call JSON is merged and passed as `OPENCODE_CONFIG_CONTENT` (see [OpenCode c
 | `permission` | `permission` map (`allow` / `deny`, patterns) |
 | `mcp` | MCP server definitions |
 | `tools` | Enable/disable tools (including MCP globs) |
+| `instructions` | Instruction file paths / glob patterns to inject |
 | `config_overrides` | Any extra top-level config keys to deep-merge |
 
 Optional env tuning: `disable_autoupdate=True` sets `OPENCODE_DISABLE_AUTOUPDATE=1`.
 Note: `ask` is intentionally rejected in subprocess mode (no interactive terminal); use `allow` or `deny`.
 
+### User config isolation
+
+By default, `RunConfig.inherit_user_config=False` makes each child `opencode`
+process see a sanitized copy of the host's global OpenCode config. The wrapper
+keeps only provider-selection keys (`$schema`, `provider`,
+`disabled_providers`, `enabled_providers`) and drops capability/configuration
+keys such as `mcp`, `agent`, `command`, `tools`, `plugin`, `skills`,
+`instructions`, `permission`, and `model`.
+
+This keeps benchmark and orchestration runs reproducible while still allowing
+provider configuration and `opencode auth` credentials to work. Project-level
+config discovered from the workspace is not suppressed.
+
+Set `inherit_user_config=True` to restore the legacy behavior of inheriting the
+host OpenCode config as-is. For reproducible runs, pass `model`, `permission`,
+`mcp`, `tools`, and `instructions` explicitly through `RunConfig`.
+
 ## CLI arguments
 
 `RunConfig` maps to flags such as `--agent`, `-m`, `-f`, `--attach`, `--title`, etc. Prompt text is appended as the final `opencode run` message argument.

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "py-opencode-wrapper"
-version = "0.2.0"
+version = "0.2.2"
 description = "Async Python wrapper for OpenCode CLI (opencode run --format json)"
 readme = "README.md"
 requires-python = ">=3.8"

{py_opencode_wrapper-0.2.0 → py_opencode_wrapper-0.2.2}/tests/test_client_async.py

@@ -49,6 +49,19 @@ def test_build_argv_with_agent_model_files() -> None:
     assert "-f" in argv
 
 
+def test_build_argv_record_thinking_adds_display_flag_only() -> None:
+    cfg = RunConfig(record_thinking=True)
+    argv = build_argv("/x/opencode", "p", cfg)
+    assert "--thinking" in argv
+    assert "--variant" not in argv
+
+
+def test_build_argv_thinking_alias_still_adds_display_flag() -> None:
+    cfg = RunConfig(thinking=True)
+    argv = build_argv("/x/opencode", "p", cfg)
+    assert "--thinking" in argv
+
+
 def test_build_env_config_content_and_autoupdate() -> None:
     cfg = RunConfig(permission={"bash": "deny"}, disable_autoupdate=True)
     env = build_env(cfg, base={"HOME": "/tmp"})
@@ -57,6 +70,23 @@ def test_build_env_config_content_and_autoupdate() -> None:
     assert env.get("OPENCODE_DISABLE_AUTOUPDATE") == "1"
 
 
+def test_build_env_sets_pwd_to_cwd() -> None:
+    """opencode's run.ts:276 reads `process.env.PWD ?? process.cwd()` to
+    resolve the project root, and the bash builtin pwd reads $PWD.
+    asyncio.create_subprocess_exec(cwd=...) only chdirs the child; PWD stays
+    inherited from the parent shell.  build_env must pin PWD to the workspace
+    so opencode and bash both see a consistent cwd."""
+    cfg = RunConfig()
+    env = build_env(cfg, base={"HOME": "/tmp", "PWD": "/some/other/dir"}, cwd="/ws/x")
+    assert env["PWD"] == "/ws/x"
+
+
+def test_build_env_without_cwd_leaves_pwd_untouched() -> None:
+    cfg = RunConfig()
+    env = build_env(cfg, base={"HOME": "/tmp", "PWD": "/parent"})
+    assert env["PWD"] == "/parent"
+
+
 @pytest.mark.asyncio
 async def test_readline_unlimited_normal_line() -> None:
     """Lines within the default 64 KiB limit are returned as-is."""