[sdk_v2] implements python sdk_v2 by prathikr · Pull Request #481 · microsoft/Foundry-Local

prathikr · 2026-03-03T22:39:35Z

mvp

vercel · 2026-03-03T22:39:40Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated (UTC)
foundry-local	Ready	Preview, Comment	Mar 5, 2026 6:32pm

Copilot

Pull request overview

Adds an MVP Python implementation of the Foundry Local SDK v2, including ctypes-based core interop, model/catalog abstractions, OpenAI-compatible clients, integration tests, packaging metadata, and CI build workflows.

Changes:

Introduces the Python SDK package (foundry_local_sdk) with core interop, catalog/model APIs, and chat/audio clients.
Adds a pytest-based integration test suite that mirrors the JS/C# SDK tests.
Adds Python build steps to GitHub Actions and wires them into the existing SDK build workflow.

Reviewed changes

Copilot reviewed 36 out of 39 changed files in this pull request and generated 12 comments.

Show a summary per file

File	Description
sdk_v2/python/test/test_model.py	Model cache + load/unload integration tests
sdk_v2/python/test/test_foundry_local_manager.py	Manager initialization/catalog exposure tests
sdk_v2/python/test/test_catalog.py	Catalog list/lookup/cached/variant tests
sdk_v2/python/test/openai/test_chat_client.py	Chat completion + streaming tests + input validation cases
sdk_v2/python/test/openai/test_audio_client.py	Audio transcription + streaming tests + validation cases
sdk_v2/python/test/openai/init.py	Test package marker for `openai/` tests
sdk_v2/python/test/detail/test_model_load_manager.py	ModelLoadManager interop + external-service tests
sdk_v2/python/test/detail/init.py	Test package marker for `detail/` tests
sdk_v2/python/test/conftest.py	Session fixtures/config shared across tests
sdk_v2/python/test/init.py	Test package marker
sdk_v2/python/test/README.md	Test-suite documentation and conventions
sdk_v2/python/src/version.py	Package version source
sdk_v2/python/src/openai/chat_client.py	OpenAI-compatible chat client implementation
sdk_v2/python/src/openai/audio_client.py	OpenAI-compatible audio transcription client implementation
sdk_v2/python/src/openai/init.py	Exports for OpenAI-compatible clients
sdk_v2/python/src/model_variant.py	Model variant operations + client creation
sdk_v2/python/src/model.py	Alias-level model wrapper over variants
sdk_v2/python/src/logging_helper.py	SDK log-level mapping helper
sdk_v2/python/src/imodel.py	Shared model interface (Model/ModelVariant)
sdk_v2/python/src/foundry_local_manager.py	Singleton manager + web-service lifecycle
sdk_v2/python/src/exception.py	SDK exception type
sdk_v2/python/src/detail/utils.py	Shared internal helpers (cached model IDs, StrEnum)
sdk_v2/python/src/detail/native_downloader.py	NuGet-based native binary downloader + CLI
sdk_v2/python/src/detail/model_load_manager.py	Load/unload abstraction (interop vs web service)
sdk_v2/python/src/detail/model_data_types.py	Pydantic models for catalog/model metadata
sdk_v2/python/src/detail/core_interop.py	ctypes FFI layer for Foundry Local Core
sdk_v2/python/src/detail/init.py	Internal module exports
sdk_v2/python/src/configuration.py	SDK configuration model + validation
sdk_v2/python/src/catalog.py	Catalog implementation (listing/lookup/cached/loaded)
sdk_v2/python/src/init.py	Top-level package exports + logger setup
sdk_v2/python/requirements.txt	Runtime dependencies
sdk_v2/python/requirements-dev.txt	Dev/test dependencies
sdk_v2/python/pyproject.toml	Packaging + pytest configuration
sdk_v2/python/examples/chat_completion.py	Example usage script
sdk_v2/python/README.md	Python SDK documentation
sdk_v2/python/LICENSE.txt	License file
sdk_v2/python/.gitignore	Python SDK ignore rules
.github/workflows/foundry-local-sdk-build.yml	Adds Python build jobs to SDK build workflow
.github/workflows/build-python-steps.yml	New reusable workflow to build/test/package Python SDK

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sdk_v2/python/src/detail/model_data_types.py

sdk_v2/python/src/model_variant.py

.github/workflows/build-python-steps.yml

sdk_v2/python/src/openai/chat_client.py

sdk_v2/python/src/logging_helper.py

sdk_v2/python/src/catalog.py

sdk_v2/python/src/detail/core_interop.py

sdk_v2/python/examples/chat_completion.py

sdk_v2/python/README.md

sdk_v2/python/test/detail/test_model_load_manager.py

Copilot

Pull request overview

Copilot reviewed 36 out of 39 changed files in this pull request and generated 9 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sdk_v2/python/src/detail/model_data_types.py

sdk_v2/python/test/openai/test_audio_client.py

sdk_v2/python/test/test_catalog.py

sdk_v2/python/src/logging_helper.py

sdk_v2/python/src/configuration.py

sdk_v2/python/src/detail/model_load_manager.py

sdk_v2/python/src/openai/chat_client.py

Copilot

Pull request overview

Copilot reviewed 36 out of 39 changed files in this pull request and generated 7 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

sdk_v2/python/src/detail/native_downloader.py

sdk_v2/python/pyproject.toml

sdk_v2/python/src/detail/core_interop.py

sdk_v2/python/src/detail/model_load_manager.py

sdk_v2/python/src/model_variant.py

sdk_v2/python/src/openai/audio_client.py

sdk_v2/python/src/configuration.py

Copilot

Copilot encountered an error and was unable to review this pull request. You can try again by re-requesting a review.

Copilot

Pull request overview

Copilot reviewed 36 out of 39 changed files in this pull request and generated 9 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-03-05T22:46:18Z

sdk_v2/python/src/openai/audio_client.py

+from dataclasses import dataclass, field
+from typing import Callable, Optional
+
+from ..detail.core_interop import CoreInterop, InteropRequest


AudioClient raises FoundryLocalException later in this file, but it is not imported here, which will cause a NameError at runtime on error paths. Import it (e.g., from ..exception import FoundryLocalException) and consider removing the unused field import from dataclasses.

Suggested change

from dataclasses import dataclass, field

from typing import Callable, Optional

from ..detail.core_interop import CoreInterop, InteropRequest

from dataclasses import dataclass

from typing import Callable, Optional

from ..detail.core_interop import CoreInterop, InteropRequest

from ..exception import FoundryLocalException

Copilot · 2026-03-05T22:46:19Z

sdk_v2/python/src/model_variant.py

+        logger.info("Download response: %s", response)
+        if response.error is not None:
+            raise FoundryLocalException(f"Failed to download model: {response.error}")


FoundryLocalException is referenced but not imported in this module, which will raise NameError when a download fails. Add the missing import (from .exception import FoundryLocalException) near the top of the file.

Copilot · 2026-03-05T22:46:19Z

sdk_v2/python/src/detail/model_load_manager.py

+                f"HTTP request failed when listing loaded models from {self._external_service_url}"
+            ) from e
+        except json.JSONDecodeError as e:
+            raise FoundryLocalException(f"Failed to decode JSON response: Response was: {response.data}") from e


response here is a requests.Response, which does not have a .data attribute; this will throw an AttributeError and mask the real JSON parsing failure. Use response.text (or capture the text into a local variable and reference that) in the exception message.

Suggested change

raise FoundryLocalException(f"Failed to decode JSON response: Response was: {response.data}") from e

raise FoundryLocalException(f"Failed to decode JSON response: Response was: {content}") from e

Copilot · 2026-03-05T22:46:19Z

sdk_v2/python/src/detail/model_load_manager.py

+        """
+        Load a model by its ID.
+        :param model_id: The ID of the model to load.
+        :raises NotImplementedError: If loading via external service is attempted.
+        """
+        if self._external_service_url:
+            self._web_load_model(model_id)
+            return


The docstring claims NotImplementedError is raised when loading via external service, but the method is implemented (_web_load_model). Update the docstring to describe the actual behavior and raised exception types.

Copilot · 2026-03-05T22:46:19Z

sdk_v2/python/pyproject.toml

+dynamic = ["version", "dependencies"]
+description = "Foundry Local Manager Python SDK: Control-plane SDK for Foundry Local."
+readme = "README.md"
+requires-python = ">=3.10"


requires-python is >=3.10 but the classifiers include Python 3.9, which is inconsistent for packaging metadata. Remove the 3.9 classifier or lower requires-python (and ensure the codebase avoids 3.10-only syntax if doing so).

Copilot · 2026-03-05T22:46:19Z

sdk_v2/python/pyproject.toml

+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.9",


requires-python is >=3.10 but the classifiers include Python 3.9, which is inconsistent for packaging metadata. Remove the 3.9 classifier or lower requires-python (and ensure the codebase avoids 3.10-only syntax if doing so).

Suggested change

"Programming Language :: Python :: 3.9",

Copilot · 2026-03-05T22:46:20Z

sdk_v2/python/test/README.md

+
+## Prerequisites
+
+1. **Python 3.9+** (tested with 3.12/3.13)


This claims Python 3.9+, but pyproject.toml sets requires-python = \">=3.10\". Update this doc to match the supported minimum version.

Suggested change

1. **Python 3.9+** (tested with 3.12/3.13)

1. **Python 3.10+** (tested with 3.12/3.13)

Copilot · 2026-03-05T22:46:20Z

sdk_v2/python/src/openai/chat_client.py

+from openai.types.chat.chat_completion_message_param import *
+from openai.types.chat.completion_create_params import CompletionCreateParamsBase, \
+                                                       CompletionCreateParamsNonStreaming, \
+                                                       CompletionCreateParamsStreaming
+from openai.types.shared_params import Metadata


Avoid import * here since it obscures what types are used and can pollute the module namespace; import only ChatCompletionMessageParam (and any other required symbols) explicitly. Also, Metadata is imported but not used in this file—removing it reduces confusion and avoids lint failures.

Suggested change

from openai.types.chat.chat_completion_message_param import *

from openai.types.chat.completion_create_params import CompletionCreateParamsBase, \

CompletionCreateParamsNonStreaming, \

CompletionCreateParamsStreaming

from openai.types.shared_params import Metadata

from openai.types.chat.chat_completion_message_param import ChatCompletionMessageParam

from openai.types.chat.completion_create_params import CompletionCreateParamsBase, \

CompletionCreateParamsNonStreaming, \

CompletionCreateParamsStreaming

Copilot · 2026-03-05T22:46:20Z

sdk_v2/python/src/imodel.py

+        pass
+
+    @abstractmethod
+    def load(self,) -> None:


The trailing comma in the method signature is unnecessary and inconsistent with the other method definitions. Consider changing it to def load(self) -> None: for readability and style consistency.

Suggested change

def load(self,) -> None:

def load(self) -> None:

mvp

05a19c3

vercel bot deployed to Preview March 3, 2026 22:40 View deployment

requests

670eede

vercel bot deployed to Preview March 3, 2026 22:43 View deployment

typo

e1aa6e2

vercel bot deployed to Preview March 3, 2026 22:52 View deployment

openai

73a12c5

vercel bot deployed to Preview March 3, 2026 22:55 View deployment

runnable from whl

54ae205

vercel bot deployed to Preview March 3, 2026 23:09 View deployment

Readme

7f655a5

vercel bot deployed to Preview March 3, 2026 23:11 View deployment

winml working

070a5ce

vercel bot deployed to Preview March 3, 2026 23:42 View deployment

naming

5514a33

vercel bot deployed to Preview March 3, 2026 23:49 View deployment

macos bug fix

d30ba9b

vercel bot deployed to Preview March 4, 2026 18:43 View deployment

prathikr requested a review from Copilot March 4, 2026 18:52

Copilot started reviewing on behalf of prathikr March 4, 2026 18:53 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

flc mac version

2a409e4

vercel bot deployed to Preview March 4, 2026 20:21 View deployment

copilot feedback

418c951

vercel bot deployed to Preview March 4, 2026 21:23 View deployment

prathikr requested a review from Copilot March 4, 2026 22:18

Copilot started reviewing on behalf of prathikr March 4, 2026 22:19 View session

Copilot AI reviewed Mar 4, 2026

View reviewed changes

more copilot feedback

fdcd592

vercel bot deployed to Preview March 4, 2026 23:58 View deployment

even more copilot feedback

9aeaab7

vercel bot deployed to Preview March 5, 2026 00:12 View deployment

prathikr requested a review from Copilot March 5, 2026 00:14

Copilot started reviewing on behalf of prathikr March 5, 2026 00:16 View session

Copilot AI reviewed Mar 5, 2026

View reviewed changes

an insane amount of copilot feedback

86131ff

prathikr requested a review from Copilot March 5, 2026 18:31

vercel bot deployed to Preview March 5, 2026 18:32 View deployment

Copilot AI reviewed Mar 5, 2026

View reviewed changes

prathikr requested a review from Copilot March 5, 2026 22:39

Copilot AI reviewed Mar 5, 2026

View reviewed changes

Copilot started reviewing on behalf of prathikr March 5, 2026 23:22 View session

	raise FoundryLocalException(f"Failed to decode JSON response: Response was: {response.data}") from e
	raise FoundryLocalException(f"Failed to decode JSON response: Response was: {content}") from e

	1. Python 3.9+ (tested with 3.12/3.13)
	1. Python 3.10+ (tested with 3.12/3.13)

Conversation

prathikr commented Mar 3, 2026

Uh oh!

vercel bot commented Mar 3, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 5, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

vercel bot commented Mar 3, 2026 •

edited

Loading