feat: add async context manager support for CopilotClient and Copilot…

[Sumanth007]

Session with automatic resource cleanup #341

This pull request introduces async context manager support for both CopilotClient and CopilotSession, enabling automatic resource cleanup and following Python best practices for resource management. The documentation is updated to recommend this pattern, and comprehensive tests ensure correct behavior and error handling. These changes make it easier and safer to use the SDK, especially in batch or evaluation scenarios.

Async context manager support and resource management:

• Added async context manager methods (__aenter__ and __aexit__) to CopilotClient and CopilotSession for automatic startup, cleanup, and error handling, ensuring resources are always released—even if exceptions occur. [1] [2]
• Updated the python/README.md to document and recommend the context manager usage pattern, including example code and benefits, and highlighted this feature in the capabilities list. [1] [2] [3]

Testing and validation:

• Added new end-to-end tests in python/e2e/test_context_managers.py to verify correct context manager behavior, including automatic cleanup, error propagation, and nested context scenarios.
• Introduced unit tests in python/test_client.py to confirm that context manager methods return the correct values and propagate exceptions as expected.

Internal improvements:

• Imported logging and TracebackType in relevant files to support error logging and context manager implementation. [1] [2]

[Copilot]

Pull request overview

Adds async context manager (async with) support to the Python SDK’s CopilotClient and CopilotSession so callers can get automatic startup/teardown, and updates Python docs + tests to encourage/verify the pattern.

Changes:

• Implemented __aenter__ / __aexit__ on CopilotClient to auto-start() and cleanup via stop().
• Implemented __aenter__ / __aexit__ on CopilotSession to auto-cleanup via destroy().
• Added unit/E2E tests and updated python/README.md to recommend async with usage.

Reviewed changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
python/copilot/client.py	Adds async context manager methods and cleanup logging for the client lifecycle.
python/copilot/session.py	Adds async context manager methods for session lifecycle cleanup.
python/test_client.py	Adds unit tests for context manager return values / exception propagation behavior.
python/e2e/test_context_managers.py	Adds E2E coverage for client/session context manager behavior and cleanup semantics.
python/README.md	Documents and recommends async with usage patterns for safer resource cleanup.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

[Copilot]

Pull request overview

Copilot reviewed 5 out of 5 changed files in this pull request and generated 1 comment.

[Copilot]

The E2E tests require snapshot files in the test/snapshots/context_managers/ directory to function properly. The test harness expects YAML snapshot files for each test to replay CAPI responses. The snapshot directory test/snapshots/context_managers/ and corresponding YAML files (e.g., should_auto_start_and_cleanup_with_context_manager.yaml, should_create_session_in_context.yaml, etc.) are missing.

The tests will fail without these snapshot files because the replaying proxy uses them to mock API responses. You'll need to either:

1. Create the snapshot directory and YAML files with appropriate test data
2. Generate the snapshots by running the tests in record mode first
3. Copy and adapt existing snapshot files from similar tests

Suggested change

	pytestmark = pytest.mark.asyncio(loop_scope="module")
	SNAPSHOT_DIR = os.path.join(
	os.path.dirname(os.path.dirname(__file__)),
	"test",
	"snapshots",
	"context_managers",
	)
	pytestmark = [
	pytest.mark.asyncio(loop_scope="module"),
	pytest.mark.skipif(
	not os.path.isdir(SNAPSHOT_DIR),
	reason="context_managers snapshots are missing; run E2E in record mode to generate them",
	),
	]