{{ message }}
Repository navigation
Expand file tree
/
Copy pathclient.py
More file actions
5565 lines (4867 loc) · 240 KB
/
Copy pathclient.py
File metadata and controls
5565 lines (4867 loc) · 240 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
"""
Copilot CLI SDK Client - Main entry point for the Copilot SDK.
This module provides the :class:`CopilotClient` class, which manages the connection
to the Copilot CLI server and provides session management capabilities.
Example:
>>> from copilot import CopilotClient
>>>
>>> async with CopilotClient() as client:
... session = await client.create_session()
... await session.send("Hello!")
"""
from __future__ import annotations
import asyncio
import inspect
import ipaddress
import logging
import os
import re
import shutil
import subprocess
import sys
import threading
import time
import uuid
from collections.abc import Awaitable, Callable, Mapping, Sequence
from dataclasses import dataclass, field
from datetime import UTC, datetime
from pathlib import Path
from types import TracebackType
from typing import Any, ClassVar, Literal, NotRequired, TypedDict, cast, overload
from ._diagnostics import log_timing
from ._ffi_runtime_host import FfiRuntimeHost
from ._jsonrpc import JsonRpcClient, JsonRpcError, ProcessExitedError
from ._mode import (
CopilotClientMode,
ToolSet,
_custom_agents_local_only_default,
_embedding_cache_storage_default,
_enable_experimental_mode_default,
_enable_file_hooks_default,
_enable_host_git_operations_default,
_enable_on_demand_instruction_discovery_default,
_enable_session_store_default,
_enable_session_telemetry_default,
_enable_skills_default,
_mcp_oauth_token_storage_default,
_memory_default,
_normalize_tool_filter,
_post_create_options_patch,
_require_available_tools_for_empty_mode,
_require_storage_for_empty_mode,
_skip_embedding_retrieval_default,
_system_message_for_mode,
_validate_tool_filter_list,
)
from ._sdk_protocol_version import get_sdk_protocol_version
from ._telemetry import get_trace_context
from .canvas import (
CanvasDeclaration,
CanvasHandler,
CanvasProviderIdentity,
ExtensionInfo,
)
from .copilot_request_handler import (
CopilotRequestHandler,
_CopilotRequestAdapterHandler,
create_copilot_request_adapter,
)
from .generated.rpc import (
ClientGlobalApiHandlers,
ClientSessionApiHandlers,
DiagnosticsConfiguration,
EntraAuthConfig,
ExtensionLaunchProviderHandler,
GitHubTelemetryNotification,
GitHubTokenAcquireReason,
GitHubTokenAcquireRequest,
GitHubTokenAcquireResult,
ModelBillingTokenPrices,
ModelBillingTokenPricesLongContext, # noqa: F401
OpenCanvasInstance,
RemoteSessionMode, # noqa: F401
SandboxConfig,
ServerRpc,
UIThreadRunRequest,
_ConnectResult,
_HookInvokeRequest,
_HookInvokeResponse,
from_datetime,
register_client_global_api_handlers,
register_client_session_api_handlers,
)
from .generated.session_events import (
SessionEvent,
session_event_from_dict,
)
from .host import AhpHost, AhpHostOptions, _AhpHostManager
from .installation_confirmation import (
InstallationConfirmationHandler,
_InstallationConfirmationAdapter,
)
from .session import (
AutoModeSwitchHandler,
AutopilotOptions,
AutoTier,
BearerTokenProvider,
CommandDefinition,
ContextTier,
CopilotSession,
CreateSessionFsHandler,
CustomAgentConfig,
DefaultAgentConfig,
ElicitationHandler,
ExitPlanModeHandler,
GitHubMcpToolConfig,
ImageGenerationConfig,
InfiniteSessionConfig,
LargeToolOutputConfig,
McpAuthHandler,
MCPServerConfig,
MemoryConfiguration,
ModelCapabilitiesOverride,
NamedProviderConfig,
ProviderConfig,
ProviderModelConfig,
ReasoningEffort,
ReasoningSummary,
SectionTransformFn,
SessionFsConfig,
SessionHooks,
SessionLimitsConfig,
SkillProvider,
SystemMessageConfig,
ToolSearchConfig,
TranscriptRecoveryReport,
UserInputHandler,
_capabilities_to_dict,
_PermissionHandlerFn,
_tools_to_wire_definitions,
)
from .session_fs_provider import SessionFsProvider, create_session_fs_adapter
from .tools import Tool
logger = logging.getLogger(__name__)
class GitHubTokenProviderArgs(TypedDict):
"""Arguments passed to a session-scoped :data:`GitHubTokenProvider`.
The opaque callback registration identifier is intentionally not exposed.
"""
host: str
session_id: str | None
reason: GitHubTokenAcquireReason
class GitHubTokenResult(TypedDict):
"""A GitHub token returned by a session-scoped provider."""
kind: Literal["token"]
accessToken: str
expiresIn: int
tokenType: NotRequired[str]
class GitHubTokenCancelledResult(TypedDict):
"""An explicit cancellation returned by a session-scoped provider."""
kind: Literal["cancelled"]
GitHubTokenProviderResult = GitHubTokenResult | GitHubTokenCancelledResult
"""Result returned by a session-scoped GitHub token provider."""
GitHubTokenProvider = Callable[
[GitHubTokenProviderArgs],
GitHubTokenProviderResult | Awaitable[GitHubTokenProviderResult],
]
"""Acquire a GitHub credential for one session.
Token results require ``expiresIn`` to be the positive number of seconds of
remaining lifetime when the callback completes. Production GitHub tokens
typically last eight hours. Initial cancellation, callback errors, and invalid
token responses reject session creation or resume instead of falling back to
ambient authentication.
"""
def _required_string_param(params: dict, name: str) -> str:
value = params.get(name) if isinstance(params, dict) else None
if not isinstance(value, str):
raise JsonRpcError(-32602, "Invalid params")
return value
# ============================================================================
# Connection Types
# ============================================================================
_ConnectionState = Literal["disconnected", "connecting", "connected", "error"]
LogLevel = Literal["none", "error", "warning", "info", "debug", "all"]
AskUserVariant = Literal["legacy", "elicitation"]
"""Model-facing shape of the runtime's built-in ``ask_user`` tool."""
@dataclass
class CloudSessionRepository:
"""GitHub repository metadata to associate with a cloud session."""
owner: str
name: str
branch: str | None = None
@dataclass
class CloudSessionOptions:
"""Options for creating a remote session in the cloud."""
repository: CloudSessionRepository | None = None
ExpFlagValue = str | int | float | bool | None
"""A single ExP (Experiment Platform) flag value.
ExP assignments resolve to a string, number, boolean, or ``None``.
"""
@dataclass
class ExpConfigEntry:
"""A single configuration entry in a :class:`CopilotExpAssignmentResponse`.
Each entry carries an identifier and a bag of typed parameter values.
"""
id: str
"""Identifier of the configuration entry."""
parameters: dict[str, ExpFlagValue] = field(default_factory=dict)
"""Parameter values keyed by parameter name."""
@dataclass
class CopilotExpAssignmentResponse:
"""ExP ("flight") assignment data.
Uses the same JSON shape the Copilot CLI fetches from the experimentation
service. Serialized on the wire with PascalCase keys to match the contract
consumed by the runtime.
"""
features: list[str] = field(default_factory=list)
"""Enabled feature names."""
flights: dict[str, str] = field(default_factory=dict)
"""Assigned flights keyed by flight name."""
configs: list[ExpConfigEntry] = field(default_factory=list)
"""Configuration entries carrying typed parameter values."""
assignment_context: str = ""
"""Assignment context string forwarded to CAPI and telemetry."""
parameter_groups: Any | None = None
"""Opaque parameter-group payload passed through untouched. Optional."""
flighting_version: int | None = None
"""Version of the flighting configuration. Optional."""
impression_id: str | None = None
"""Impression identifier for the assignment. Optional."""
def _exp_assignment_response_to_dict(
response: CopilotExpAssignmentResponse,
) -> dict[str, Any]:
wire: dict[str, Any] = {
"Features": list(response.features),
"Flights": dict(response.flights),
"Configs": [
{"Id": entry.id, "Parameters": dict(entry.parameters)} for entry in response.configs
],
"AssignmentContext": response.assignment_context,
}
if response.parameter_groups is not None:
wire["ParameterGroups"] = response.parameter_groups
if response.flighting_version is not None:
wire["FlightingVersion"] = response.flighting_version
if response.impression_id is not None:
wire["ImpressionId"] = response.impression_id
return wire
class CapiSessionOptions(TypedDict, total=False):
"""Provider-scoped Copilot API (CAPI) session options."""
auto_tier: AutoTier
"""Routing preference used when the session model is ``auto``.
Requires a runtime with Auto tier support and V2 Auto routing. When omitted
on create, the runtime uses its default routing behavior. The runtime persists
this preference across cold resume; when omitted on cold resume, it restores
the last committed preference. On resident resume, a different tier requests a
safe switch that takes effect after resume succeeds and never disturbs a turn
that is already running.
To change the preference on a live session, call
:meth:`CopilotSession.set_auto_tier` instead.
"""
enable_web_socket_responses: bool
"""Whether to use WebSocket transport for the CAPI Responses API.
Enabled by default when the model advertises ``ws:/responses`` support. Set
to ``False`` to force the HTTP Responses transport instead, which is
equivalent to the ``COPILOT_CLI_DISABLE_WEBSOCKET_RESPONSES`` environment
variable and useful in environments where WebSockets are blocked (e.g.
behind a proxy).
"""
def _cloud_session_options_to_dict(options: CloudSessionOptions) -> dict[str, Any]:
result: dict[str, Any] = {}
if options.repository is not None:
repository: dict[str, Any] = {
"owner": options.repository.owner,
"name": options.repository.name,
}
if options.repository.branch is not None:
repository["branch"] = options.repository.branch
result["repository"] = repository
return result
def _capi_session_options_to_wire(options: CapiSessionOptions) -> dict[str, Any]:
wire: dict[str, Any] = {}
if "auto_tier" in options:
wire["autoTier"] = options["auto_tier"]
if "enable_web_socket_responses" in options:
wire["enableWebSocketResponses"] = options["enable_web_socket_responses"]
return wire
class DisableBypassPermissionsModes:
"""Well-known managed bypass-permissions policies."""
DISABLE: ClassVar[str] = "disable"
"""Turn off bypass-permissions mode entirely."""
ALLOW_AUTO_ONLY: ClassVar[str] = "allow-auto-only"
"""Permit automatic bypass but block full allow-all."""
@dataclass
class ManagedSettingsPermissions:
"""Permissions-only managed policy injected via :class:`ManagedSettings`.
Rule strings use the same vocabulary the runtime accepts for fetched
managed policy (e.g. ``"Read(**)"``, ``"Shell(git push *)"``); malformed
rules are rejected by the runtime at session creation.
"""
disable_bypass_permissions_mode: str | None = None
"""Restricts bypass-permissions mode for the session. See
:class:`DisableBypassPermissionsModes` for well-known values. Unknown values
are forwarded so newer runtime policies fail closed. Sent on the wire as
``disableBypassPermissionsMode``."""
deny: list[str] | None = None
"""Operations that must always be denied. Unioned across managed layers."""
ask: list[str] | None = None
"""Operations that must prompt for approval. Unioned across managed layers."""
allow: list[str] | None = None
"""Operations permitted without prompting. Every declared ``allow`` list
across managed layers must admit an operation for it to be allowed."""
limit_to: list[str] | None = None
"""Closed-world host boundary expressed as ``Domain(hostname)``,
``Domain(IP)``, or ``Domain(*.example.com)`` rules. Schemes, ports, paths,
queries, and fragments are rejected. Multiple managed layers intersect
their lists; an empty list denies all hosts. Sent on the wire as
``limitTo``."""
disable_assisted_permissions_mode: bool | None = None
"""When true, prevents Assisted Permissions from being activated. Omit or
set to false to impose no restriction. Sent on the wire as
``disableAssistedPermissionsMode``."""
@dataclass
class ManagedSettings:
"""Host-injected enterprise managed settings for a session.
Unlike ``enable_managed_settings`` — which asks the runtime to *self-fetch*
account/org and device policy — this supplies the managed policy directly.
The runtime validates it with the same managed-permission parser it uses
for fetched policy and composes it restrictively with any self-fetched
(server) and device-managed (MDM) layers.
The first supported contract is permissions-only; unknown sibling keys are
rejected by the runtime. Serialized on the wire as ``managedSettings``.
"""
permissions: ManagedSettingsPermissions | None = None
"""Managed permission policy for the session."""
def _managed_settings_to_dict(settings: ManagedSettings) -> dict[str, Any]:
wire: dict[str, Any] = {}
permissions = settings.permissions
if permissions is not None:
perms: dict[str, Any] = {}
if permissions.disable_bypass_permissions_mode is not None:
perms["disableBypassPermissionsMode"] = permissions.disable_bypass_permissions_mode
if permissions.disable_assisted_permissions_mode is not None:
perms["disableAssistedPermissionsMode"] = permissions.disable_assisted_permissions_mode
if permissions.deny is not None:
perms["deny"] = list(permissions.deny)
if permissions.ask is not None:
perms["ask"] = list(permissions.ask)
if permissions.allow is not None:
perms["allow"] = list(permissions.allow)
if permissions.limit_to is not None:
perms["limitTo"] = list(permissions.limit_to)
wire["permissions"] = perms
return wire
# Implicit provider name for the singular, whole-session ``provider`` config.
# Named providers are keyed by their own ``name``.
_DEFAULT_BEARER_TOKEN_PROVIDER_NAME = "default"
def _collect_bearer_token_callbacks(
provider: ProviderConfig | None,
providers: list[NamedProviderConfig] | None,
) -> dict[str, BearerTokenProvider]:
"""Collect per-provider ``bearer_token_provider`` callbacks keyed by provider name.
The singular, whole-session ``provider`` uses the implicit
``_DEFAULT_BEARER_TOKEN_PROVIDER_NAME``; ``providers`` entries use their own
``name``. The callbacks are never serialized — the wire conversion emits
``hasBearerTokenProvider: true`` instead and the runtime calls back over
``providerToken.getToken``.
"""
callbacks: dict[str, BearerTokenProvider] = {}
if provider is not None:
singular = provider.get("bearer_token_provider")
if singular is not None:
callbacks[_DEFAULT_BEARER_TOKEN_PROVIDER_NAME] = singular
if providers:
for named in providers:
callback = named.get("bearer_token_provider")
if callback is not None:
callbacks[named["name"]] = callback
return callbacks
def _validate_session_fs_config(config: SessionFsConfig) -> None:
if not config.get("initial_working_directory"):
raise ValueError("session_fs.initial_working_directory is required")
if not config.get("session_state_path"):
raise ValueError("session_fs.session_state_path is required")
if config.get("conventions") not in ("posix", "windows"):
raise ValueError("session_fs.conventions must be either 'posix' or 'windows'")
def _mcp_servers_to_wire(
servers: dict[str, Any],
) -> dict[str, Any]:
"""Convert MCP server configs from public API format to wire format.
Renames ``working_directory`` key to ``cwd`` in each server config dict.
"""
wire: dict[str, Any] = {}
for name, config in servers.items():
if "working_directory" in config:
config = {**config, "cwd": config["working_directory"]}
del config["working_directory"]
wire[name] = config
return wire
def _large_output_to_wire(config: Mapping[str, Any]) -> dict[str, Any]:
"""Convert a ``LargeToolOutputConfig`` mapping to wire format."""
wire: dict[str, Any] = {}
if "enabled" in config:
wire["enabled"] = config["enabled"]
if "max_size_bytes" in config:
wire["maxSizeBytes"] = config["max_size_bytes"]
if "output_directory" in config:
wire["outputDir"] = config["output_directory"]
return wire
def _memory_to_wire(config: Mapping[str, Any]) -> dict[str, Any]:
"""Convert a ``MemoryConfiguration`` mapping to wire format."""
wire: dict[str, Any] = {"enabled": config["enabled"]}
if "mode" in config:
wire["mode"] = config["mode"]
return wire
def _autopilot_to_wire(config: AutopilotOptions) -> dict[str, Any]:
wire: dict[str, Any] = {}
if "continuation_enabled" in config:
wire["continuationEnabled"] = config["continuation_enabled"]
if "max_continues" in config:
wire["maxContinues"] = config["max_continues"]
return wire
def _session_limits_to_wire(config: Mapping[str, Any]) -> dict[str, Any]:
"""Convert a ``SessionLimitsConfig`` mapping to wire format."""
wire: dict[str, Any] = {}
if "max_ai_credits" in config:
wire["maxAiCredits"] = config["max_ai_credits"]
return wire
def _tool_search_to_wire(config: Mapping[str, Any]) -> dict[str, Any]:
"""Convert a ``ToolSearchConfig`` mapping to wire format."""
wire: dict[str, Any] = {}
if "enabled" in config:
wire["enabled"] = config["enabled"]
if "defer_threshold" in config:
wire["deferThreshold"] = config["defer_threshold"]
return wire
def _image_generation_to_wire(config: Mapping[str, Any]) -> dict[str, Any]:
"""Convert an ``ImageGenerationConfig`` mapping to wire format."""
wire = dict(config)
if "save_to_disk" in wire:
wire["saveToDisk"] = wire.pop("save_to_disk")
return wire
def _github_mcp_tool_config_to_wire(config: Mapping[str, Any]) -> dict[str, Any]:
"""Convert a ``GitHubMcpToolConfig`` mapping to wire format."""
wire: dict[str, Any] = {}
if "enable_all_tools" in config:
wire["enableAllTools"] = config["enable_all_tools"]
if "additional_toolsets" in config:
wire["additionalToolsets"] = config["additional_toolsets"]
if "additional_tools" in config:
wire["additionalTools"] = config["additional_tools"]
if "enable_insiders_mode" in config:
wire["enableInsidersMode"] = config["enable_insiders_mode"]
if "disable_form_deferral" in config:
wire["disableFormDeferral"] = config["disable_form_deferral"]
return wire
class TelemetryConfig(TypedDict, total=False):
"""Configuration for OpenTelemetry integration with the Copilot CLI."""
otlp_endpoint: str
"""OTLP HTTP endpoint URL for trace/metric export. Sets OTEL_EXPORTER_OTLP_ENDPOINT."""
otlp_protocol: Literal["http/json", "http/protobuf"]
"""OTLP HTTP protocol for all signals.
Allowed values are "http/json" and "http/protobuf". Sets OTEL_EXPORTER_OTLP_PROTOCOL.
"""
file_path: str
"""File path for JSON-lines trace output. Sets COPILOT_OTEL_FILE_EXPORTER_PATH."""
exporter_type: str
"""Exporter backend type: "otlp-http" or "file". Sets COPILOT_OTEL_EXPORTER_TYPE."""
source_name: str
"""Instrumentation scope name. Sets COPILOT_OTEL_SOURCE_NAME."""
capture_content: bool
"""Whether to capture message content. Sets OTEL_INSTRUMENTATION_GENAI_CAPTURE_MESSAGE_CONTENT.""" # noqa: E501
class ClientInfo(TypedDict, total=False):
"""Identity of the integrating application, declared on ``server.connect``.
Declaring it lets the telemetry the runtime emits on this connection be
attributed to a single, consistent surface (the application and its Copilot
integration) instead of the runtime's own build. All fields are optional;
omit any of them (or the whole object) to keep the default attribution.
"""
application_name: str
"""Name of the application using the SDK, e.g. ``"acme-developer-portal"``."""
application_version: str
"""Version of the application using the SDK, e.g. ``"2.4.0"``."""
integration_name: str
"""Optional name of an application integration, such as an extension or plugin."""
integration_version: str
"""Optional version of the integration named by ``integration_name``."""
def _client_info_to_wire(client_info: ClientInfo | None) -> dict[str, str] | None:
"""Map a snake_case :class:`ClientInfo` onto the camelCase connect wire shape.
Empty fields are dropped. Returns ``None`` when no field carries a non-empty
value so the caller omits the ``clientInfo`` field entirely and keeps the
runtime's default attribution.
"""
if not client_info:
return None
wire: dict[str, str] = {}
if client_info.get("application_name"):
wire["editorName"] = client_info["application_name"]
if client_info.get("application_version"):
wire["editorVersion"] = client_info["application_version"]
if client_info.get("integration_name"):
wire["extensionName"] = client_info["integration_name"]
if client_info.get("integration_version"):
wire["extensionVersion"] = client_info["integration_version"]
return wire or None
@dataclass
class RuntimeConnection:
"""Discriminated config describing how to reach the Copilot runtime.
Construct via the static factories :meth:`for_stdio`, :meth:`for_tcp`,
or :meth:`for_uri`. Each factory returns the matching subclass;
pattern-match on the subclass (or :func:`isinstance`) to branch on the
transport.
Example:
>>> CopilotClient() # default: stdio with the bundled runtime
>>> CopilotClient(connection=RuntimeConnection.for_uri("localhost:3000"))
"""
@staticmethod
def for_stdio(
*,
path: str | None = None,
args: Sequence[str] = (),
) -> StdioRuntimeConnection:
"""Spawn a runtime child process and communicate over its stdin/stdout.
This is the default when no :attr:`CopilotClientOptions.connection`
is supplied.
Args:
path: Path to the runtime executable. When ``None``, uses the
bundled binary.
args: Extra command-line arguments passed to the runtime process.
"""
return StdioRuntimeConnection(path=path, args=tuple(args))
@staticmethod
def for_tcp(
*,
port: int = 0,
connection_token: str | None = None,
path: str | None = None,
args: Sequence[str] = (),
) -> TcpRuntimeConnection:
"""Spawn a runtime child process listening on a TCP socket.
Args:
port: TCP port to listen on. ``0`` (the default) auto-allocates
a free port. If the chosen port is already in use, startup
fails.
connection_token: Optional shared secret the SDK sends to the
spawned runtime to authenticate the TCP connection. When
``None``, a UUID is generated automatically so the loopback
listener is safe by default.
path: Path to the runtime executable. When ``None``, uses the
bundled binary.
args: Extra command-line arguments passed to the runtime process.
"""
return TcpRuntimeConnection(
path=path,
args=tuple(args),
port=port,
connection_token=connection_token,
)
@staticmethod
def for_uri(url: str, *, connection_token: str | None = None) -> UriRuntimeConnection:
"""Connect to an already-running runtime at the given URL.
Args:
url: URL of the runtime to connect to. Accepts ``"port"``,
``"host:port"``, or a full URL.
connection_token: Optional shared secret to authenticate the
connection. Required when the server was started with a
token; ignored by legacy servers without ``connect`` support.
"""
return UriRuntimeConnection(url=url, connection_token=connection_token)
@staticmethod
def for_inprocess(
*,
run_on_ui_thread: Callable[[Callable[[], None]], None | Awaitable[None]] | None = None,
) -> InProcessRuntimeConnection:
"""Host the runtime **in-process** via its native C ABI (FFI).
**Experimental.** The in-process (FFI) transport is experimental and its
behavior may change or be removed in a future release.
Instead of spawning the runtime as a child process, the SDK loads the
runtime's native shared library into this process and drives JSON-RPC
over its C ABI.
Because the runtime loads into this single shared process, per-client
options that lower to environment variables or a working directory
cannot be honored: :attr:`CopilotClientOptions.env`,
:attr:`CopilotClientOptions.telemetry`, and
:attr:`CopilotClientOptions.working_directory` are rejected with this
transport. Set those on the host process before creating the client.
Set ``COPILOT_CLI_PATH`` only when using an externally provisioned
compatible runtime package.
Args:
run_on_ui_thread: Native UI scheduler, required for OneAuth interactive
authentication on macOS. See
:attr:`InProcessRuntimeConnection.run_on_ui_thread` for its
main-thread execution contract and other uses.
Note:
Pre-provision the native runtime with
``python -m copilot download-runtime --in-process`` when automatic
downloads are disabled.
"""
return InProcessRuntimeConnection(run_on_ui_thread=run_on_ui_thread)
@dataclass
class ChildProcessRuntimeConnection(RuntimeConnection):
"""Base for :class:`RuntimeConnection` variants that spawn a runtime child process.
Construct via :meth:`RuntimeConnection.stdio` or :meth:`RuntimeConnection.tcp`.
"""
path: str | None = None
"""Path to the runtime executable. ``None`` uses the bundled binary."""
args: Sequence[str] = ()
"""Extra command-line arguments passed to the runtime process."""
env: dict[str, str] | None = None
"""Per-connection environment variables for the spawned child process.
When set, do not also set :attr:`CopilotClientOptions.env` — the client
rejects setting environment in both places. ``None`` inherits the
client-level env (or the current process env)."""
@dataclass
class StdioRuntimeConnection(ChildProcessRuntimeConnection):
"""Spawns a runtime child process and communicates over its stdin/stdout.
Construct via :meth:`RuntimeConnection.stdio`.
"""
@dataclass
class TcpRuntimeConnection(ChildProcessRuntimeConnection):
"""Spawns a runtime child process listening on a TCP socket.
Construct via :meth:`RuntimeConnection.tcp`.
"""
port: int = 0
"""TCP port to listen on. ``0`` (the default) auto-allocates a free port."""
connection_token: str | None = None
"""Shared secret the SDK sends to the spawned runtime. ``None`` auto-generates one."""
@dataclass
class UriRuntimeConnection(RuntimeConnection):
"""Connects to an already-running runtime at the specified URL.
Construct via :meth:`RuntimeConnection.uri`.
"""
url: str = ""
"""URL of the runtime to connect to. Accepts ``"port"``, ``"host:port"``, or a full URL."""
connection_token: str | None = None
"""Shared secret to authenticate the connection."""
@dataclass
class InProcessRuntimeConnection(RuntimeConnection):
"""Hosts the runtime in-process via its native C ABI (FFI).
**Experimental.** The in-process (FFI) transport is experimental and its
behavior may change or be removed in a future release.
Construct via :meth:`RuntimeConnection.for_inprocess`. The runtime's native
shared library is loaded into this process and JSON-RPC is driven over its
C ABI.
"""
run_on_ui_thread: Callable[[Callable[[], None]], None | Awaitable[None]] | None = None
"""Experimental: schedule the supplied native action exactly once on the UI
thread (the process main thread on macOS), completing only after it returns.
The action can block while native UI is open. No authentication data crosses
this callback. Other in-process clients may share this process-wide capability.
Required for OneAuth interactive authentication on macOS. This general-purpose
scheduler may also be used for other runtime-owned native UI operations.
Temporary OneAuth workaround; this API may be removed if no longer needed.
See https://github.com/github/copilot-agent-runtime/issues/27032."""
class _UiThreadAdapter:
def __init__(self, client: CopilotClient) -> None:
self._client = client
async def run(self, params: UIThreadRunRequest) -> None:
connection = self._client._connection
host = self._client._ffi_host
if (
not isinstance(connection, InProcessRuntimeConnection)
or connection.run_on_ui_thread is None
or host is None
):
raise RuntimeError("No in-process run_on_ui_thread handler is configured.")
if not 0 <= params.action_id <= 0xFFFFFFFF:
raise ValueError("UI action ID must be an unsigned 32-bit integer.")
result = connection.run_on_ui_thread(lambda: host.run_ui_action(params.action_id))
if inspect.isawaitable(result):
await result
class _GitHubTelemetryAdapter:
"""Adapts a user-provided ``on_github_telemetry`` callback to the generated
``GitHubTelemetryHandler`` protocol.
"""
def __init__(
self,
callback: Callable[[GitHubTelemetryNotification], None | Awaitable[None]],
) -> None:
self._callback = callback
async def event(self, params: GitHubTelemetryNotification) -> None:
try:
result = self._callback(params)
if inspect.isawaitable(result):
await result
except Exception:
logger.warning("Error handling gitHubTelemetry.event notification", exc_info=True)
@dataclass
class _GitHubTokenProviderRegistration:
provider: GitHubTokenProvider
session_id: str | None = None
committed: bool = False
class _GitHubTokenProviderAdapter:
"""Routes global GitHub token requests to opaque session registrations."""
def __init__(self, client: CopilotClient) -> None:
self._client = client
async def get_token(self, params: GitHubTokenAcquireRequest) -> GitHubTokenAcquireResult:
with self._client._github_token_providers_lock:
registration = self._client._github_token_providers.get(params.registration_id)
if registration is None:
raise JsonRpcError(
-32603,
"No GitHub token provider registered for registration ID "
f"{params.registration_id!r}",
)
result = registration.provider(
GitHubTokenProviderArgs(
host=params.host,
session_id=params.session_id or registration.session_id,
reason=params.reason,
)
)
if inspect.isawaitable(result):
result = await result
# The generated global-handler wrapper forwards callback results directly,
# so the public tagged dictionary is already in the expected wire shape.
return cast(GitHubTokenAcquireResult, result)
class _HooksAdapter:
"""Adapts session-scoped hook dispatch to the generated ``HooksHandler`` protocol.
``hooks.invoke`` is a client-global RPC method whose payload carries a
``sessionId``. This adapter routes each invocation to the matching session's
registered hook handlers.
"""
def __init__(self, get_session: Callable[[str], CopilotSession | None]) -> None:
self._get_session = get_session
async def invoke(self, params: _HookInvokeRequest) -> _HookInvokeResponse:
session = self._get_session(params.session_id)
if session is None:
raise ValueError(f"unknown session {params.session_id}")
output = await session._handle_hooks_invoke(params.hook_type.value, params.input)
return _HookInvokeResponse(output=output)
@dataclass
class _CopilotClientOptions:
"""Internal configuration carrier used by :class:`CopilotClient`.
This is not part of the public API: ``CopilotClient`` accepts all of
these options as keyword arguments directly.
"""
entra: EntraAuthConfig | None = None
connection: RuntimeConnection | None = None
working_directory: str | None = None
log_level: LogLevel = "info"
env: dict[str, str] | None = None
github_token: str | None = None
base_directory: str | None = None
builtin_plugin_directories: tuple[str, ...] = ()
extension_launch_provider: ExtensionLaunchProviderHandler | None = None
installation_confirmation_handler: InstallationConfirmationHandler | None = None
use_logged_in_user: bool | None = None
telemetry: TelemetryConfig | None = None
session_fs: SessionFsConfig | None = None
request_handler: CopilotRequestHandler | None = None
session_idle_timeout_seconds: int | None = None
client_info: ClientInfo | None = None
on_list_models: Callable[[], list[ModelInfo] | Awaitable[list[ModelInfo]]] | None = None
on_github_telemetry: Callable[[GitHubTelemetryNotification], None | Awaitable[None]] | None = (
None
)
mode: CopilotClientMode = "copilot-cli"
# ============================================================================
# Response Types
# ============================================================================
@dataclass
class PingResponse:
"""Response from ping"""
message: str # Echo message with "pong: " prefix
timestamp: datetime # Timestamp when the ping was processed
protocol_version: int # Protocol version for SDK compatibility
@staticmethod
def from_dict(obj: Any) -> PingResponse:
assert isinstance(obj, dict)
message = obj.get("message")
timestamp = obj.get("timestamp")
protocol_version = obj.get("protocolVersion")
if message is None or timestamp is None or protocol_version is None:
raise ValueError(
f"Missing required fields in PingResponse: message={message}, "
f"timestamp={timestamp}, protocolVersion={protocol_version}"
)
timestamp_value = (
datetime.fromtimestamp(timestamp / 1000, tz=UTC)
if isinstance(timestamp, (int, float))
else from_datetime(timestamp)
)
return PingResponse(str(message), timestamp_value, int(protocol_version))
def to_dict(self) -> dict:
result: dict = {}
result["message"] = self.message
result["timestamp"] = self.timestamp.isoformat()
result["protocolVersion"] = self.protocol_version
return result
@dataclass
class StopError(Exception):
"""Error that occurred during client stop cleanup."""
message: str # Error message describing what failed during cleanup
def __post_init__(self) -> None:
Exception.__init__(self, self.message)
@staticmethod
def from_dict(obj: Any) -> StopError:
assert isinstance(obj, dict)
message = obj.get("message")
if message is None:
raise ValueError("Missing required field 'message' in StopError")
return StopError(str(message))
def to_dict(self) -> dict:
result: dict = {}
result["message"] = self.message
return result
@dataclass
class GetStatusResponse:
"""Response from status.get"""
version: str # Package version (e.g., "1.0.0")
protocol_version: int # Protocol version for SDK compatibility
You can’t perform that action at this time.