__init__.py

"""
Copilot SDK - Python Client for GitHub Copilot CLI

JSON-RPC based SDK for programmatic control of GitHub Copilot CLI
"""

from importlib.metadata import PackageNotFoundError
from importlib.metadata import version as _pkg_version

from . import rpc as rpc  # noqa: F401  -- register the public ``copilot.rpc`` namespace

# Register the public ``copilot.session_events`` namespace.
from . import session_events as session_events  # noqa: F401
from ._mode import (
    BUILTIN_TOOLS_ISOLATED,
    CopilotClientMode,
    ToolSet,
)
from .canvas import (
    CanvasAction,
    CanvasDeclaration,
    CanvasError,
    CanvasHandler,
    CanvasHostContext,
    CanvasHostContextCapabilities,
    CanvasJsonSchema,
    CanvasProviderIdentity,
    ExtensionInfo,
    OpenCanvasInstance,
)
from .client import (
    AskUserVariant,
    AutoTier,
    CapiSessionOptions,
    ChildProcessRuntimeConnection,
    ClientInfo,
    CloudSessionOptions,
    CloudSessionRepository,
    CopilotClient,
    CopilotExpAssignmentResponse,
    DisableBypassPermissionsModes,
    ExpConfigEntry,
    ExpFlagValue,
    GetAuthStatusResponse,
    GetStatusResponse,
    GitHubTokenCancelledResult,
    GitHubTokenProvider,
    GitHubTokenProviderArgs,
    GitHubTokenProviderResult,
    GitHubTokenResult,
    InProcessRuntimeConnection,
    LogLevel,
    ManagedSettings,
    ManagedSettingsPermissions,
    ModelBilling,
    ModelCapabilities,
    ModelInfo,
    ModelLimits,
    ModelPolicy,
    ModelSupports,
    ModelVisionLimits,
    PingResponse,
    RemoteSessionMode,
    RuntimeConnection,
    SessionBackgroundEvent,
    SessionContext,
    SessionCreatedEvent,
    SessionDeletedEvent,
    SessionForegroundEvent,
    SessionLifecycleEvent,
    SessionLifecycleEventBase,
    SessionLifecycleEventMetadata,
    SessionLifecycleEventType,
    SessionLifecycleHandler,
    SessionListFilter,
    SessionMetadata,
    SessionUpdatedEvent,
    StdioRuntimeConnection,
    StopError,
    TcpRuntimeConnection,
    TelemetryConfig,
    UriRuntimeConnection,
)
from .copilot_request_handler import (
    CopilotRequestContext,
    CopilotRequestHandler,
    CopilotWebSocketCloseStatus,
    CopilotWebSocketForwarder,
    CopilotWebSocketHandler,
    LlmInferenceHeaders,
)
from .generated.rpc import (
    CurrentModel,
    CurrentToolMetadata,
    ExtensionLaunchProfile,
    ExtensionLaunchProviderHandler,
    ExtensionLaunchProviderResolveRequest,
    ExtensionLaunchProviderResolveResult,
    GitHubTelemetryClientInfo,
    GitHubTelemetryEvent,
    GitHubTelemetryNotification,
    GitHubTokenAcquireReason,
    GitHubTokenAcquireResult,
    GitHubTokenAcquireResultKind,
    ModelBillingTokenPrices,
    ModelBillingTokenPricesLongContext,
    ModelSwitchAutoTierResult,
    ModelSwitchAutoTierStatus,
    PermissionDecisionContext,
    PermissionDecisionOutcome,
    PermissionDecisionSurface,
    PermissionResponseCapability,
    SkillProviderDescriptor,
)
from .generated.session_events import (
    AutoTierSwitchFailureReason,
    PermissionDecisionSource,
    PermissionRequest,
    SessionAutoTierSwitchFailedData,
    SessionEvent,
    SessionEventType,
)
from .host import (
    AhpHost,
    AhpHostExit,
    AhpHostOptions,
    AhpSessionCreateRequest,
    AhpSessionResumeRequest,
)
from .installation_confirmation import (
    InstallationConfirmationContext,
    InstallationConfirmationDecision,
    InstallationConfirmationHandler,
)
from .session import (
    AgentMessageSource,
    AgentStopHandler,
    AgentStopHookInput,
    AgentStopHookOutput,
    AttributedPermissionResult,
    AutoModeSwitchHandler,
    AutoModeSwitchRequest,
    AutoModeSwitchResponse,
    BearerTokenProvider,
    CommandContext,
    CommandDefinition,
    CopilotSession,
    CreateSessionFsHandler,
    ElicitationContext,
    ElicitationHandler,
    ElicitationParams,
    ElicitationResult,
    ErrorOccurredHandler,
    ErrorOccurredHookInput,
    ErrorOccurredHookOutput,
    ExitPlanModeHandler,
    ExitPlanModeRequest,
    ExitPlanModeResult,
    GitHubMcpToolConfig,
    ImageGenerationConfig,
    InfiniteSessionConfig,
    InputOptions,
    LargeToolOutputConfig,
    McpAuthContext,
    McpAuthHandler,
    McpAuthRequest,
    McpAuthResult,
    McpAuthStaticClientConfig,
    McpAuthToken,
    McpAuthWwwAuthenticateParams,
    MCPHTTPServerConfig,
    MCPServerConfig,
    MCPStdioServerConfig,
    MessageSource,
    ModelCapabilitiesOverride,
    ModelLimitsOverride,
    ModelSupportsOverride,
    ModelVisionLimitsOverride,
    NamedProviderConfig,
    PermissionHandler,
    PermissionNoResult,
    PermissionRequestResult,
    PostToolUseFailureHandler,
    PostToolUseFailureHookInput,
    PostToolUseFailureHookOutput,
    PostToolUseHandler,
    PostToolUseHookInput,
    PostToolUseHookOutput,
    PreMcpToolCallHandler,
    PreMcpToolCallHookInput,
    PreMcpToolCallHookOutput,
    PreToolUseHandler,
    PreToolUseHookInput,
    PreToolUseHookOutput,
    ProviderConfig,
    ProviderConfigModelProvider,
    ProviderModelConfig,
    ProviderTokenArgs,
    ReasoningSummary,
    SessionCapabilities,
    SessionEndHandler,
    SessionEndHookInput,
    SessionEndHookOutput,
    SessionEventHandler,
    SessionFsCapabilities,
    SessionFsConfig,
    SessionHooks,
    SessionLimitsConfig,
    SessionStartHandler,
    SessionStartHookInput,
    SessionStartHookOutput,
    SessionUiApi,
    SessionUiCapabilities,
    SkillProvider,
    SubagentStartHandler,
    SubagentStartHookInput,
    SubagentStartHookOutput,
    SubagentStopHandler,
    SubagentStopHookInput,
    SubagentStopHookOutput,
    SystemMessageConfig,
    ToolSearchConfig,
    TranscriptRecoveryReport,
    UserInputHandler,
    UserInputRequest,
    UserInputResponse,
    UserPromptSubmittedHandler,
    UserPromptSubmittedHookInput,
    UserPromptSubmittedHookOutput,
    UserPromptTransformedHandler,
    UserPromptTransformedHookInput,
    UserPromptTransformedHookOutput,
    create_attributed_permission_result,
)
from .session_fs_provider import (
    SessionFsBinaryProvider,
    SessionFsFileInfo,
    SessionFsProvider,
    SessionFsSqliteProvider,
    SessionFsSqliteQueryResult,
    SessionFsSqliteTransactionFailure,
    SessionFsWriteFailure,
    create_session_fs_adapter,
)
from .tools import (
    Tool,
    ToolBinaryResult,
    ToolInvocation,
    ToolResult,
    ToolResultType,
    convert_mcp_call_tool_result,
    define_tool,
)

try:
    __version__ = _pkg_version("github-copilot-sdk")
except PackageNotFoundError:
    # No installed package metadata (e.g. running from a source checkout that
    # was never installed). Use a sentinel that can never masquerade as a real
    # release rather than a hardcoded version that would silently go stale.
    __version__ = "0.0.0.dev0"

__all__ = [
    "AhpHost",
    "AhpHostExit",
    "AhpHostOptions",
    "AhpSessionCreateRequest",
    "AhpSessionResumeRequest",
    "AgentMessageSource",
    "AgentStopHandler",
    "AgentStopHookInput",
    "AgentStopHookOutput",
    "AttributedPermissionResult",
    "AutoModeSwitchHandler",
    "AutoModeSwitchRequest",
    "AutoModeSwitchResponse",
    "AskUserVariant",
    "AutoTier",
    "SessionAutoTierSwitchFailedData",
    "AutoTierSwitchFailureReason",
    "CurrentModel",
    "ModelSwitchAutoTierResult",
    "ModelSwitchAutoTierStatus",
    "BUILTIN_TOOLS_ISOLATED",
    "CanvasAction",
    "CanvasDeclaration",
    "CanvasError",
    "CanvasHandler",
    "CanvasHostContext",
    "CanvasHostContextCapabilities",
    "CanvasJsonSchema",
    "CanvasProviderIdentity",
    "CapiSessionOptions",
    "ChildProcessRuntimeConnection",
    "ClientInfo",
    "CloudSessionOptions",
    "CloudSessionRepository",
    "CommandContext",
    "CommandDefinition",
    "CopilotClient",
    "CopilotClientMode",
    "CopilotExpAssignmentResponse",
    "CopilotSession",
    "TranscriptRecoveryReport",
    "CopilotRequestContext",
    "CopilotRequestHandler",
    "CopilotWebSocketCloseStatus",
    "CopilotWebSocketHandler",
    "CreateSessionFsHandler",
    "CurrentToolMetadata",
    "ElicitationContext",
    "ElicitationHandler",
    "ElicitationParams",
    "ElicitationResult",
    "ErrorOccurredHandler",
    "ErrorOccurredHookInput",
    "ErrorOccurredHookOutput",
    "ExpConfigEntry",
    "ExpFlagValue",
    "ExitPlanModeHandler",
    "ExitPlanModeRequest",
    "ExitPlanModeResult",
    "ExtensionLaunchProfile",
    "ExtensionLaunchProviderHandler",
    "ExtensionLaunchProviderResolveRequest",
    "ExtensionLaunchProviderResolveResult",
    "ExtensionInfo",
    "CopilotWebSocketForwarder",
    "DisableBypassPermissionsModes",
    "GetAuthStatusResponse",
    "BearerTokenProvider",
    "GetStatusResponse",
    "GitHubMcpToolConfig",
    "GitHubTelemetryClientInfo",
    "GitHubTelemetryEvent",
    "GitHubTelemetryNotification",
    "GitHubTokenAcquireReason",
    "GitHubTokenAcquireResult",
    "GitHubTokenAcquireResultKind",
    "GitHubTokenProvider",
    "GitHubTokenProviderArgs",
    "GitHubTokenProviderResult",
    "GitHubTokenResult",
    "GitHubTokenCancelledResult",
    "InfiniteSessionConfig",
    "InstallationConfirmationContext",
    "InstallationConfirmationDecision",
    "InstallationConfirmationHandler",
    "InProcessRuntimeConnection",
    "InputOptions",
    "LargeToolOutputConfig",
    "LlmInferenceHeaders",
    "LogLevel",
    "MCPHTTPServerConfig",
    "MCPServerConfig",
    "MCPStdioServerConfig",
    "McpAuthContext",
    "McpAuthHandler",
    "McpAuthRequest",
    "McpAuthResult",
    "McpAuthStaticClientConfig",
    "McpAuthToken",
    "McpAuthWwwAuthenticateParams",
    "ManagedSettings",
    "ManagedSettingsPermissions",
    "MessageSource",
    "ModelBilling",
    "ModelBillingTokenPrices",
    "ModelBillingTokenPricesLongContext",
    "ModelCapabilities",
    "ModelCapabilitiesOverride",
    "ModelInfo",
    "ModelLimits",
    "ModelLimitsOverride",
    "ModelPolicy",
    "ModelSupports",
    "ModelSupportsOverride",
    "ModelVisionLimits",
    "ModelVisionLimitsOverride",
    "NamedProviderConfig",
    "OpenCanvasInstance",
    "PermissionHandler",
    "PermissionNoResult",
    "PermissionRequest",
    "PermissionRequestResult",
    "PermissionDecisionContext",
    "PermissionDecisionOutcome",
    "PermissionDecisionSource",
    "PermissionDecisionSurface",
    "PermissionResponseCapability",
    "PingResponse",
    "PostToolUseHandler",
    "PostToolUseFailureHandler",
    "PostToolUseFailureHookInput",
    "PostToolUseFailureHookOutput",
    "PostToolUseHookInput",
    "PostToolUseHookOutput",
    "PreMcpToolCallHandler",
    "PreMcpToolCallHookInput",
    "PreMcpToolCallHookOutput",
    "PreToolUseHandler",
    "PreToolUseHookInput",
    "PreToolUseHookOutput",
    "ProviderConfig",
    "ProviderConfigModelProvider",
    "ProviderModelConfig",
    "ProviderTokenArgs",
    "ReasoningSummary",
    "RemoteSessionMode",
    "RuntimeConnection",
    "rpc",
    "session_events",
    "SessionBackgroundEvent",
    "SessionCapabilities",
    "SessionContext",
    "SessionCreatedEvent",
    "SessionDeletedEvent",
    "SessionEndHandler",
    "SessionEndHookInput",
    "SessionEndHookOutput",
    "SessionEvent",
    "SessionEventHandler",
    "SessionEventType",
    "SessionForegroundEvent",
    "SessionFsCapabilities",
    "SessionFsConfig",
    "SessionFsFileInfo",
    "SessionFsProvider",
    "SessionFsBinaryProvider",
    "SessionFsSqliteProvider",
    "SessionFsSqliteQueryResult",
    "SessionFsSqliteTransactionFailure",
    "SessionFsWriteFailure",
    "SessionHooks",
    "SessionLimitsConfig",
    "SessionLifecycleEvent",
    "SessionLifecycleEventBase",
    "SessionLifecycleEventMetadata",
    "SessionLifecycleEventType",
    "SessionLifecycleHandler",
    "SessionListFilter",
    "SessionMetadata",
    "SessionStartHandler",
    "SessionStartHookInput",
    "SessionStartHookOutput",
    "SkillProvider",
    "SkillProviderDescriptor",
    "SessionUiApi",
    "SessionUiCapabilities",
    "SessionUpdatedEvent",
    "StdioRuntimeConnection",
    "StopError",
    "SubagentStartHandler",
    "SubagentStartHookInput",
    "SubagentStartHookOutput",
    "SubagentStopHandler",
    "SubagentStopHookInput",
    "SubagentStopHookOutput",
    "SystemMessageConfig",
    "TcpRuntimeConnection",
    "TelemetryConfig",
    "Tool",
    "ToolBinaryResult",
    "ToolInvocation",
    "ToolResult",
    "ToolResultType",
    "ToolSearchConfig",
    "ImageGenerationConfig",
    "ToolSet",
    "UriRuntimeConnection",
    "UserInputHandler",
    "UserInputRequest",
    "UserInputResponse",
    "UserPromptSubmittedHandler",
    "UserPromptSubmittedHookInput",
    "UserPromptSubmittedHookOutput",
    "UserPromptTransformedHandler",
    "UserPromptTransformedHookInput",
    "UserPromptTransformedHookOutput",
    "convert_mcp_call_tool_result",
    "create_attributed_permission_result",
    "create_session_fs_adapter",
    "define_tool",
]