Python: Migrate GitHub Copilot package to SDK 0.2.x (#5107)

* Python: Migrate GitHub Copilot package to SDK 0.2.x

Replace all imports from the non-existent copilot.types module with
correct SDK 0.2.x module paths (copilot.session, copilot.client,
copilot.tools, copilot.generated.session_events). Fix PermissionRequest
attribute access from dict-style .get() to dataclass attribute access.
Add OTel telemetry support to Copilot samples via configure_otel_providers
and document new telemetry environment variables in samples README.

* Python: Fix remaining copilot.types import in sample validation script

* Python: Include model in default_options for telemetry span attributes

* Python: Address review feedback on log_level and session kwargs typing

* Python: Scope PR to SDK 0.2.x migration only, remove net-new OTel features

- Remove RawGitHubCopilotAgent split and AgentTelemetryLayer inheritance
- Remove TelemetryConfig plumbing and OTLP/file telemetry settings
- Remove configure_otel_providers() calls from samples
- Remove telemetry env var rows from samples README
- Retain only: import path fixes, PermissionRequest attribute access fix,
  log_level default fix, session kwargs typed fix, dependency pin

* Python: Update tests for SDK 0.2.x API changes

- SubprocessConfig replaces CopilotClientOptions dict
- create_session and resume_session now use keyword args
- send and send_and_wait take plain string prompt instead of MessageOptions
- on_permission_request is always required; deny-all fallback replaces omission

* Python: Pin github-copilot-sdk to >=0.2.0,<=0.2.0

Tighten the upper bound from <0.3.0 to <=0.2.0 to avoid pulling in 0.2.1+
which has breaking API changes relative to 0.2.0. The lower bound stays at
>=0.2.0 since this migration requires the 0.2.x import paths; 0.1.x would
fail at import time.

* Python: Pin github-copilot-sdk to >=0.2.1,<=0.2.1

---------

Co-authored-by: Evan Mattson <35585003+moonbox3@users.noreply.github.com>

Author: droideronline

python/packages/github_copilot/agent_framework_github_copilot/_agent.py

@@ -7,7 +7,7 @@
 import logging
 import sys
 from collections.abc import AsyncIterable, Awaitable, Callable, MutableMapping, Sequence
-from typing import Any, ClassVar, Generic, Literal, TypedDict, cast, overload
+from typing import Any, ClassVar, Generic, Literal, TypedDict, overload
 
 from agent_framework import (
     AgentMiddlewareTypes,
@@ -29,20 +29,11 @@
 from agent_framework.exceptions import AgentException
 
 try:
-    from copilot import CopilotClient, CopilotSession
+    from copilot import CopilotClient, CopilotSession, SubprocessConfig
     from copilot.generated.session_events import PermissionRequest, SessionEvent, SessionEventType
-    from copilot.types import (
-        CopilotClientOptions,
-        MCPServerConfig,
-        MessageOptions,
-        PermissionRequestResult,
-        ResumeSessionConfig,
-        SessionConfig,
-        SystemMessageConfig,
-        ToolInvocation,
-        ToolResult,
-    )
-    from copilot.types import Tool as CopilotTool
+    from copilot.session import MCPServerConfig, PermissionRequestResult, SystemMessageConfig
+    from copilot.tools import Tool as CopilotTool
+    from copilot.tools import ToolInvocation, ToolResult
 except ImportError as _copilot_import_error:
     raise ImportError(
         "GitHubCopilotAgent requires the 'github-copilot-sdk' package, which is only available on Python 3.11+. "
@@ -64,6 +55,14 @@
 logger = logging.getLogger("agent_framework.github_copilot")
 
 
+def _deny_all_permissions(
+    _request: PermissionRequest,
+    _invocation: dict[str, str],
+) -> PermissionRequestResult:
+    """Default permission handler that denies all requests."""
+    return PermissionRequestResult()
+
+
 class GitHubCopilotSettings(TypedDict, total=False):
     """GitHub Copilot model settings.
 
@@ -274,16 +273,13 @@ async def start(self) -> None:
             return
 
         if self._client is None:
-            client_options: CopilotClientOptions = {}
-            cli_path = self._settings.get("cli_path")
-            if cli_path:
-                client_options["cli_path"] = cli_path
+            cli_path = self._settings.get("cli_path") or None
+            log_level = self._settings.get("log_level") or None
 
-            log_level = self._settings.get("log_level")
+            subprocess_kwargs: dict[str, Any] = {"cli_path": cli_path}
             if log_level:
-                client_options["log_level"] = log_level  # type: ignore[typeddict-item]
-
-            self._client = CopilotClient(client_options if client_options else None)
+                subprocess_kwargs["log_level"] = log_level
+            self._client = CopilotClient(SubprocessConfig(**subprocess_kwargs))
 
         try:
             await self._client.start()
@@ -407,10 +403,9 @@ async def _run_impl(
         prompt = "\n".join([message.text for message in context_messages])
         if session_context.instructions:
             prompt = "\n".join(session_context.instructions) + "\n" + prompt
-        message_options = cast(MessageOptions, {"prompt": prompt})
 
         try:
-            response_event = await copilot_session.send_and_wait(message_options, timeout=timeout)
+            response_event = await copilot_session.send_and_wait(prompt, timeout=timeout)
         except Exception as ex:
             raise AgentException(f"GitHub Copilot request failed: {ex}") from ex
 
@@ -489,7 +484,6 @@ async def _stream_updates(
         prompt = "\n".join([message.text for message in context_messages])
         if session_context.instructions:
             prompt = "\n".join(session_context.instructions) + "\n" + prompt
-        message_options = cast(MessageOptions, {"prompt": prompt})
 
         queue: asyncio.Queue[AgentResponseUpdate | Exception | None] = asyncio.Queue()
 
@@ -550,7 +544,7 @@ def event_handler(event: SessionEvent) -> None:
         unsubscribe = copilot_session.on(event_handler)
 
         try:
-            await copilot_session.send(message_options)
+            await copilot_session.send(prompt)
 
             while (item := await queue.get()) is not None:
                 if isinstance(item, Exception):
@@ -730,43 +724,35 @@ async def _create_session(
             raise RuntimeError("GitHub Copilot client not initialized. Call start() first.")
 
         opts = runtime_options or {}
-        config: SessionConfig = {"streaming": streaming}
-
-        model = opts.get("model") or self._settings.get("model")
-        if model:
-            config["model"] = model  # type: ignore[typeddict-item]
-
-        system_message = opts.get("system_message") or self._default_options.get("system_message")
-        if system_message:
-            config["system_message"] = system_message
-
-        if self._tools:
-            config["tools"] = self._prepare_tools(self._tools)
-
-        permission_handler = opts.get("on_permission_request") or self._permission_handler
-        if permission_handler:
-            config["on_permission_request"] = permission_handler
-
-        mcp_servers = opts.get("mcp_servers") or self._mcp_servers
-        if mcp_servers:
-            config["mcp_servers"] = mcp_servers
-
-        return await self._client.create_session(config)
+        model = opts.get("model") or self._settings.get("model") or None
+        system_message = opts.get("system_message") or self._default_options.get("system_message") or None
+        permission_handler: PermissionHandlerType = (
+            opts.get("on_permission_request") or self._permission_handler or _deny_all_permissions
+        )
+        mcp_servers = opts.get("mcp_servers") or self._mcp_servers or None
+        tools = self._prepare_tools(self._tools) if self._tools else None
+
+        return await self._client.create_session(
+            on_permission_request=permission_handler,
+            streaming=streaming,
+            model=model or None,
+            system_message=system_message or None,
+            tools=tools or None,
+            mcp_servers=mcp_servers or None,
+        )
 
     async def _resume_session(self, session_id: str, streaming: bool) -> CopilotSession:
         """Resume an existing Copilot session by ID."""
         if not self._client:
             raise RuntimeError("GitHub Copilot client not initialized. Call start() first.")
 
-        config: ResumeSessionConfig = {"streaming": streaming}
-
-        if self._tools:
-            config["tools"] = self._prepare_tools(self._tools)
+        permission_handler: PermissionHandlerType = self._permission_handler or _deny_all_permissions
+        tools = self._prepare_tools(self._tools) if self._tools else None
 
-        if self._permission_handler:
-            config["on_permission_request"] = self._permission_handler
-
-        if self._mcp_servers:
-            config["mcp_servers"] = self._mcp_servers
-
-        return await self._client.resume_session(session_id, config)
+        return await self._client.resume_session(
+            session_id,
+            on_permission_request=permission_handler,
+            streaming=streaming,
+            tools=tools or None,
+            mcp_servers=self._mcp_servers or None,
+        )

python/packages/github_copilot/pyproject.toml

@@ -24,7 +24,7 @@ classifiers = [
 ]
 dependencies = [
     "agent-framework-core>=1.0.0,<2",
-    "github-copilot-sdk>=0.1.31,<0.1.33; python_version >= '3.11'",
+    "github-copilot-sdk>=0.2.1,<=0.2.1; python_version >= '3.11'",
 ]
 
 [tool.uv]
@@ -102,3 +102,4 @@ interpreter = "posix"
 [build-system]
 requires = ["flit-core >= 3.11,<4.0"]
 build-backend = "flit_core.buildapi"
+