[python] `copilot.generated` exposed as part of the public API

[brettcannon]

https://github.com/github/copilot-sdk/blob/main/python/copilot/generated/__init__.py Makes it clear that the copilot.generated subpackage is not meant to be public:

copilot-sdk/python/copilot/generated/__init__.py

Line 3 in cd2b10b

This package is not part of the public API. Import from `copilot` (session-event

But the subpackage doesn't start with an underscore to signify it's an implementation detail: copilot._generated.

As well, https://github.com/github/copilot-sdk/blob/main/python/copilot/rpc.py and https://github.com/github/copilot-sdk/blob/main/python/copilot/session_events.py which are meant to act as the public API potentially over-expose things. While copilot.rpc does export something explicitly:

copilot-sdk/python/copilot/rpc.py

Lines 10 to 11 in cd2b10b

	from .generated.rpc import (
	SessionFsReaddirWithTypesEntryType as SessionFSReaddirWithTypesEntryType, # noqa: F401

... both files also do an import * followed by an import of __all__ from the generated code which lists everything contained in the generated code. E.g.:

copilot-sdk/python/copilot/session_events.py

Lines 9 to 10 in cd2b10b

	from .generated.session_events import * # noqa: F401, F403
	from .generated.session_events import __all__ # noqa: F401

exposes 330 symbols in the module:

copilot-sdk/python/copilot/generated/session_events.py

Lines 9883 to 10215 in cd2b10b

	__all__ = [
	"AbortData",
	"AbortReason",
	"AssistantIdleData",
	"AssistantIntentData",
	"AssistantMessageData",
	"AssistantMessageDeltaData",
	"AssistantMessageServerTools",
	"AssistantMessageStartData",
	"AssistantMessageToolRequest",
	"AssistantMessageToolRequestType",
	"AssistantReasoningData",
	"AssistantReasoningDeltaData",
	"AssistantServerToolProgressData",
	"AssistantStreamingDeltaData",
	"AssistantToolCallDeltaData",
	"AssistantTurnEndData",
	"AssistantTurnRetryData",
	"AssistantTurnStartData",
	"AssistantUsageApiEndpoint",
	"AssistantUsageCopilotUsage",
	"AssistantUsageCopilotUsageTokenDetail",
	"AssistantUsageData",
	"Attachment",
	"AttachmentBlob",
	"AttachmentDirectory",
	"AttachmentExtensionContext",
	"AttachmentFile",
	"AttachmentFileLineRange",
	"AttachmentGitHubActionsJob",
	"AttachmentGitHubCommit",
	"AttachmentGitHubFile",
	"AttachmentGitHubFileDiff",
	"AttachmentGitHubFileDiffSide",
	"AttachmentGitHubReference",
	"AttachmentGitHubReferenceType",
	"AttachmentGitHubRelease",
	"AttachmentGitHubRepository",
	"AttachmentGitHubSnippet",
	"AttachmentGitHubTreeComparison",
	"AttachmentGitHubTreeComparisonSide",
	"AttachmentGitHubUrl",
	"AttachmentSelection",
	"AttachmentSelectionDetails",
	"AttachmentSelectionDetailsEnd",
	"AttachmentSelectionDetailsStart",
	"AutoApprovalRecommendation",
	"AutoModeResolvedReasoningBucket",
	"AutoModeSwitchCompletedData",
	"AutoModeSwitchRequestedData",
	"AutoModeSwitchResponse",
	"AutopilotObjectiveChangedOperation",
	"AutopilotObjectiveChangedStatus",
	"BinaryAssetReference",
	"BinaryAssetReferenceType",
	"BinaryAssetType",
	"CanvasRegistryChangedCanvas",
	"CanvasRegistryChangedCanvasAction",
	"CapabilitiesChangedData",
	"CapabilitiesChangedUI",
	"CitableSource",
	"CitationLocation",
	"CitationLocationBlock",
	"CitationLocationChar",
	"CitationLocationPage",
	"CitationProvider",
	"CitationReference",
	"CitationSource",
	"CitationSpan",
	"Citations",
	"CommandCompletedData",
	"CommandExecuteData",
	"CommandQueuedData",
	"CommandsChangedCommand",
	"CommandsChangedData",
	"CompactionCompleteCompactionTokensUsed",
	"CompactionCompleteCompactionTokensUsedCopilotUsageTokenDetail",
	"ContextTier",
	"CustomAgentsUpdatedAgent",
	"Data",
	"ElicitationCompletedAction",
	"ElicitationCompletedData",
	"ElicitationRequestedData",
	"ElicitationRequestedMode",
	"ElicitationRequestedSchema",
	"EmbeddedBlobResourceContents",
	"EmbeddedTextResourceContents",
	"ExitPlanModeAction",
	"ExitPlanModeCompletedData",
	"ExitPlanModeRequestedData",
	"ExtensionsLoadedExtension",
	"ExtensionsLoadedExtensionSource",
	"ExtensionsLoadedExtensionStatus",
	"ExternalToolCompletedData",
	"ExternalToolRequestedData",
	"GitHubRepoRef",
	"HandoffRepository",
	"HandoffSourceType",
	"HeaderEntry",
	"HookEndData",
	"HookEndError",
	"HookProgressData",
	"HookStartData",
	"ManagedSettingsEnforcedAction",
	"ManagedSettingsEnforcedEscalation",
	"ManagedSettingsResolvedSource",
	"McpAppToolCallCompleteData",
	"McpAppToolCallCompleteError",
	"McpAppToolCallCompleteToolMeta",
	"McpAppToolCallCompleteToolMetaUI",
	"McpHeadersRefreshCompletedData",
	"McpHeadersRefreshCompletedOutcome",
	"McpHeadersRefreshRequiredData",
	"McpHeadersRefreshRequiredReason",
	"McpOauthCompletedData",
	"McpOauthCompletionOutcome",
	"McpOauthHttpResponse",
	"McpOauthRequestReason",
	"McpOauthRequiredData",
	"McpOauthRequiredStaticClientConfig",
	"McpOauthWWWAuthenticateParams",
	"McpPromptsListChangedData",
	"McpResourcesListChangedData",
	"McpServerSource",
	"McpServerStatus",
	"McpServerTransport",
	"McpServersLoadedServer",
	"McpToolsListChangedData",
	"ModelCallFailureBadRequestKind",
	"ModelCallFailureData",
	"ModelCallFailureKind",
	"ModelCallFailureRequestFingerprint",
	"ModelCallFailureSource",
	"ModelCallFailureTransport",
	"ModelCallStartData",
	"OmittedBinaryOmittedReason",
	"OmittedBinaryResult",
	"OmittedBinaryType",
	"PendingMessagesModifiedData",
	"PermissionAllowAllMode",
	"PermissionApproved",
	"PermissionApprovedForLocation",
	"PermissionApprovedForSession",
	"PermissionAutoApproval",
	"PermissionCancelled",
	"PermissionCompletedData",
	"PermissionDeniedByContentExclusionPolicy",
	"PermissionDeniedByPermissionRequestHook",
	"PermissionDeniedByRules",
	"PermissionDeniedInteractivelyByUser",
	"PermissionDeniedNoApprovalRuleAndCouldNotRequestFromUser",
	"PermissionPromptRequest",
	"PermissionPromptRequestCommands",
	"PermissionPromptRequestCustomTool",
	"PermissionPromptRequestExtensionManagement",
	"PermissionPromptRequestExtensionPermissionAccess",
	"PermissionPromptRequestHook",
	"PermissionPromptRequestMcp",
	"PermissionPromptRequestMemory",
	"PermissionPromptRequestPath",
	"PermissionPromptRequestPathAccessKind",
	"PermissionPromptRequestRead",
	"PermissionPromptRequestUrl",
	"PermissionPromptRequestWrite",
	"PermissionRequest",
	"PermissionRequestCustomTool",
	"PermissionRequestExtensionManagement",
	"PermissionRequestExtensionPermissionAccess",
	"PermissionRequestHook",
	"PermissionRequestMcp",
	"PermissionRequestMemory",
	"PermissionRequestMemoryAction",
	"PermissionRequestMemoryDirection",
	"PermissionRequestRead",
	"PermissionRequestShell",
	"PermissionRequestShellCommand",
	"PermissionRequestShellPossibleUrl",
	"PermissionRequestUrl",
	"PermissionRequestWrite",
	"PermissionRequestedData",
	"PermissionResult",
	"PermissionRule",
	"PersistedBinaryImage",
	"PersistedBinaryImageType",
	"PersistedBinaryResult",
	"PlanChangedOperation",
	"RawSessionEventData",
	"ReasoningSummary",
	"SamplingCompletedData",
	"SamplingRequestedData",
	"SessionAutoModeResolvedData",
	"SessionAutopilotObjectiveChangedData",
	"SessionBackgroundTasksChangedData",
	"SessionBinaryAssetData",
	"SessionCanvasClosedData",
	"SessionCanvasOpenedData",
	"SessionCanvasRecordedData",
	"SessionCanvasRegistryChangedData",
	"SessionCanvasRemovedData",
	"SessionCanvasUnavailableData",
	"SessionCompactionCompleteData",
	"SessionCompactionStartData",
	"SessionContextChangedData",
	"SessionCustomAgentsUpdatedData",
	"SessionCustomNotificationData",
	"SessionErrorData",
	"SessionEvent",
	"SessionEventData",
	"SessionEventType",
	"SessionExtensionsAttachmentsPushedData",
	"SessionExtensionsLoadedData",
	"SessionHandoffData",
	"SessionIdleData",
	"SessionInfoData",
	"SessionLimitsConfig",
	"SessionLimitsExhaustedCompletedData",
	"SessionLimitsExhaustedRequestedData",
	"SessionLimitsExhaustedResponse",
	"SessionLimitsExhaustedResponseAction",
	"SessionManagedSettingsEnforcedData",
	"SessionManagedSettingsResolvedData",
	"SessionMcpServerStatusChangedData",
	"SessionMcpServersLoadedData",
	"SessionMode",
	"SessionModeChangedData",
	"SessionModelChangeData",
	"SessionPermissionsChangedData",
	"SessionPlanChangedData",
	"SessionRemoteSteerableChangedData",
	"SessionResumeData",
	"SessionScheduleCancelledData",
	"SessionScheduleCreatedData",
	"SessionScheduleRearmedData",
	"SessionSessionLimitsChangedData",
	"SessionShutdownData",
	"SessionSkillsLoadedData",
	"SessionSnapshotRewindData",
	"SessionStartData",
	"SessionTaskCompleteData",
	"SessionTitleChangedData",
	"SessionTodosChangedData",
	"SessionToolsUpdatedData",
	"SessionTruncationData",
	"SessionUsageCheckpointData",
	"SessionUsageInfoData",
	"SessionWarningData",
	"SessionWorkspaceFileChangedData",
	"ShutdownCodeChanges",
	"ShutdownModelMetric",
	"ShutdownModelMetricRequests",
	"ShutdownModelMetricTokenDetail",
	"ShutdownModelMetricUsage",
	"ShutdownTokenDetail",
	"ShutdownType",
	"SkillInvokedData",
	"SkillInvokedTrigger",
	"SkillSource",
	"SkillsLoadedSkill",
	"SubagentCompletedData",
	"SubagentDeselectedData",
	"SubagentFailedData",
	"SubagentSelectedData",
	"SubagentStartedData",
	"SystemMessageData",
	"SystemMessageMetadata",
	"SystemMessageRole",
	"SystemNotification",
	"SystemNotificationAgentCompleted",
	"SystemNotificationAgentCompletedStatus",
	"SystemNotificationAgentIdle",
	"SystemNotificationData",
	"SystemNotificationInstructionDiscovered",
	"SystemNotificationNewInboxMessage",
	"SystemNotificationShellCompleted",
	"SystemNotificationShellDetachedCompleted",
	"ToolExecutionCompleteContent",
	"ToolExecutionCompleteContentAudio",
	"ToolExecutionCompleteContentImage",
	"ToolExecutionCompleteContentResource",
	"ToolExecutionCompleteContentResourceDetails",
	"ToolExecutionCompleteContentResourceLink",
	"ToolExecutionCompleteContentResourceLinkIcon",
	"ToolExecutionCompleteContentResourceLinkIconTheme",
	"ToolExecutionCompleteContentShellExit",
	"ToolExecutionCompleteContentTerminal",
	"ToolExecutionCompleteContentText",
	"ToolExecutionCompleteData",
	"ToolExecutionCompleteError",
	"ToolExecutionCompleteResult",
	"ToolExecutionCompleteToolDescription",
	"ToolExecutionCompleteToolDescriptionMeta",
	"ToolExecutionCompleteToolDescriptionMetaUI",
	"ToolExecutionCompleteToolDescriptionMetaUIVisibility",
	"ToolExecutionCompleteUIResource",
	"ToolExecutionCompleteUIResourceMeta",
	"ToolExecutionCompleteUIResourceMetaUI",
	"ToolExecutionCompleteUIResourceMetaUICsp",
	"ToolExecutionCompleteUIResourceMetaUIPermissions",
	"ToolExecutionCompleteUIResourceMetaUIPermissionsCamera",
	"ToolExecutionCompleteUIResourceMetaUIPermissionsClipboardWrite",
	"ToolExecutionCompleteUIResourceMetaUIPermissionsGeolocation",
	"ToolExecutionCompleteUIResourceMetaUIPermissionsMicrophone",
	"ToolExecutionPartialResultData",
	"ToolExecutionProgressData",
	"ToolExecutionStartData",
	"ToolExecutionStartShellToolInfo",
	"ToolExecutionStartToolDescription",
	"ToolExecutionStartToolDescriptionMeta",
	"ToolExecutionStartToolDescriptionMetaUI",
	"ToolExecutionStartToolDescriptionMetaUIVisibility",
	"ToolSearchActivatedData",
	"ToolUserRequestedData",
	"UserInputCompletedData",
	"UserInputRequestedData",
	"UserMessageAgentMode",
	"UserMessageData",
	"UserMessageDelivery",
	"UserToolSessionApproval",
	"UserToolSessionApprovalCommands",
	"UserToolSessionApprovalCustomTool",
	"UserToolSessionApprovalExtensionManagement",
	"UserToolSessionApprovalExtensionPermissionAccess",
	"UserToolSessionApprovalMcp",
	"UserToolSessionApprovalMemory",
	"UserToolSessionApprovalRead",
	"UserToolSessionApprovalWrite",
	"Verbosity",
	"WorkingDirectoryContext",
	"WorkingDirectoryContextHostType",
	"WorkspaceFileChangedOperation",
	"session_event_from_dict",
	"session_event_to_dict",
	]

I'm not sure if all 330 symbols are meant to be exposed, but at least copilot.generated should be made private by renaming it to copilot._generated. If all of those symbols are meant to be exposed then that one-liner in copilot.rpc might as well be removed. If they are not meant to be exposed then the import __all__ and import * should go and you can explicitly set __all__ in the exporting modules.

[github-actions]

Investigation Findings

I reviewed the code paths mentioned in this issue:

• python/copilot/generated/__init__.py — clearly documents itself as internal/not public API
• python/copilot/rpc.py — re-exports from generated.rpc
• python/copilot/session_events.py — re-exports from generated.session_events

What I Found

The report is accurate on both points:

1. copilot.generated naming: The package docstring explicitly says it is not part of the public API, yet it lacks the leading underscore (_) that Python convention requires to signal a private package. Any user can import copilot.generated without any warning from tools or static analysis that they're using an internal API. Renaming it to copilot._generated would enforce the documented intent.

2. from .generated.X import __all__: Both copilot/rpc.py and copilot/session_events.py import __all__ from the generated modules directly. This means the generated __all__ list is adopted verbatim as the public surface — any symbol added/removed in generated code automatically changes what the public modules export, without an explicit curation step. Combined with import *, this also exposes all 330+ symbols from generated/session_events.py through copilot.session_events.

Classification

This is a genuine bug: copilot.generated is documented as not public, but the naming convention doesn't enforce that. Python's standard convention for private packages/modules is a leading underscore, which IDEs and tools like pyright and pylint respect. The mismatch between documented intent and implementation is a real defect.

Labeling as bug.

Warning

Firewall blocked 1 domain

The following domain was blocked by the firewall during workflow execution:

• awmgmcpg

To allow these domains, add them to the network.allowed list in your workflow frontmatter:

network:
  allowed:
    - defaults
    - "awmgmcpg"

See Network Configuration for more information.

Generated by Bug Handler for #2048 · 33.1 AIC · ⌖ 5.04 AIC · ⊞ 4.5K · ◷