agent/agent-framework
1
0
Fork 0
mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00
Code Issues Packages Projects Releases Wiki Activity

Python: improved loading (#202)

Browse Source 
* improved loading

* updated openai folder imports

* fixed import
This commit is contained in:
Eduard van Valkenburg
2025-07-18 21:17:30 +02:00
committed by GitHub
Unverified
parent fc999e2be8
commit 9287572b0d
19 changed files with 201 additions and 252 deletions
Download Patch File Download Diff File Expand all files Collapse all files
python/packages/azure/tests/unit/test_azure_chat_client.py
+1 -1
View File
@@ -14,7 +14,7 @@ from agent_framework import (
TextContent,
)
from agent_framework.exceptions import ServiceInitializationError, ServiceResponseException
from agent_framework.openai.exceptions import (
from agent_framework.openai import (
ContentFilterResultSeverity,
OpenAIContentFilterException,
)
python/packages/main/agent_framework/__init__.py
+6 -59
View File
@@ -2,68 +2,15 @@
import importlib
import importlib.metadata
from typing import Any
try:
__version__ = importlib.metadata.version(__name__)
except importlib.metadata.PackageNotFoundError:
__version__ = "0.0.0" # Fallback for development mode
_IMPORTS = {
"AFBaseModel": "._pydantic",
"AFBaseSettings": "._pydantic",
"Agent": "._agents",
"AgentRunResponse": "._types",
"AgentRunResponseUpdate": "._types",
"AgentThread": "._agents",
"AITool": "._tools",
"AIFunction": "._tools",
"AIContent": "._types",
"AIContents": "._types",
"ChatClient": "._clients",
"ChatClientAgent": "._agents",
"ChatClientAgentThread": "._agents",
"ChatClientAgentThreadType": "._agents",
"ChatClientBase": "._clients",
"ChatFinishReason": "._types",
"ChatMessage": "._types",
"ChatOptions": "._types",
"ChatResponse": "._types",
"ChatResponseUpdate": "._types",
"ChatRole": "._types",
"ChatToolMode": "._types",
"DataContent": "._types",
"EmbeddingGenerator": "._clients",
"ErrorContent": "._types",
"FunctionCallContent": "._types",
"FunctionResultContent": "._types",
"GeneratedEmbeddings": "._types",
"HttpsUrl": "._pydantic",
"InputGuardrail": ".guard_rails",
"OutputGuardrail": ".guard_rails",
"SpeechToTextOptions": "._types",
"StructuredResponse": "._types",
"TextContent": "._types",
"TextReasoningContent": "._types",
"TextToSpeechOptions": "._types",
"UriContent": "._types",
"UsageContent": "._types",
"UsageDetails": "._types",
"ai_function": "._tools",
"get_logger": "._logging",
"use_tool_calling": "._clients",
}
def __getattr__(name: str) -> Any:
if name == "__version__":
return __version__
if name in _IMPORTS:
submod_name = _IMPORTS[name]
module = importlib.import_module(submod_name, package=__name__)
return getattr(module, name)
raise AttributeError(f"module {__name__} has no attribute {name}")
def __dir__() -> list[str]:
return [*list(_IMPORTS.keys()), "__version__"]
from ._agents import * # noqa: F403
from ._clients import * # noqa: F403
from ._logging import * # noqa: F403
from ._pydantic import * # noqa: F403
from ._tools import * # noqa: F403
from ._types import * # noqa: F403
python/packages/main/agent_framework/__init__.pyi
-81
View File
@@ -1,81 +0,0 @@
# Copyright (c) Microsoft. All rights reserved.
from . import __version__ # type: ignore[attr-defined]
from ._agents import Agent, AgentThread, ChatClientAgent, ChatClientAgentThread, ChatClientAgentThreadType
from ._clients import ChatClient, ChatClientBase, EmbeddingGenerator, use_tool_calling
from ._logging import get_logger
from ._pydantic import AFBaseModel, AFBaseSettings, HttpsUrl
from ._tools import AIFunction, AITool, ai_function
from ._types import (
AgentRunResponse,
AgentRunResponseUpdate,
AIContent,
AIContents,
ChatFinishReason,
ChatMessage,
ChatOptions,
ChatResponse,
ChatResponseUpdate,
ChatRole,
ChatToolMode,
DataContent,
ErrorContent,
FunctionCallContent,
FunctionResultContent,
GeneratedEmbeddings,
SpeechToTextOptions,
StructuredResponse,
TextContent,
TextReasoningContent,
TextToSpeechOptions,
UriContent,
UsageContent,
UsageDetails,
)
from .guard_rails import InputGuardrail, OutputGuardrail
__all__ = [
"AFBaseModel",
"AFBaseSettings",
"AIContent",
"AIContents",
"AIFunction",
"AITool",
"Agent",
"AgentRunResponse",
"AgentRunResponseUpdate",
"AgentThread",
"ChatClient",
"ChatClientAgent",
"ChatClientAgentThread",
"ChatClientAgentThreadType",
"ChatClientBase",
"ChatFinishReason",
"ChatMessage",
"ChatOptions",
"ChatResponse",
"ChatResponseUpdate",
"ChatRole",
"ChatToolMode",
"DataContent",
"EmbeddingGenerator",
"ErrorContent",
"FunctionCallContent",
"FunctionResultContent",
"GeneratedEmbeddings",
"HttpsUrl",
"InputGuardrail",
"OutputGuardrail",
"SpeechToTextOptions",
"StructuredResponse",
"TextContent",
"TextReasoningContent",
"TextToSpeechOptions",
"UriContent",
"UsageContent",
"UsageDetails",
"__version__",
"ai_function",
"get_logger",
"use_tool_calling",
]
python/packages/main/agent_framework/_agents.py
+10
View File
@@ -26,6 +26,16 @@ TThreadType = TypeVar("TThreadType", bound="AgentThread")
# region AgentThread
__all__ = [
"Agent",
"AgentBase",
"AgentThread",
"ChatClientAgent",
"ChatClientAgentThread",
"ChatClientAgentThreadType",
"MessagesRetrievableThread",
]
class AgentThread(AFBaseModel):
"""Base class for agent threads."""
python/packages/main/agent_framework/_clients.py
+11 -3
View File
@@ -34,6 +34,13 @@ TChatClientBase = TypeVar("TChatClientBase", bound="ChatClientBase")
logger = get_logger()
__all__ = [
"ChatClient",
"ChatClientBase",
"EmbeddingGenerator",
"use_tool_calling",
]
# region: Tool Calling Functions and Decorators
@@ -88,7 +95,8 @@ def _prepare_tools_and_tool_choice(chat_options: ChatOptions) -> None:
chat_options.tool_choice = ChatToolMode.NONE.mode
return
chat_options.tools = [
(_tool_to_json_schema_spec(t) if isinstance(t, AITool) else t) for t in chat_options._ai_tools or []
(_tool_to_json_schema_spec(t) if isinstance(t, AITool) else t)
for t in chat_options._ai_tools or [] # type: ignore[reportPrivateUsage]
]
if not chat_options.tools:
chat_options.tool_choice = ChatToolMode.NONE.mode
@@ -126,7 +134,7 @@ def _tool_call_non_streaming(func: TInnerGetResponse) -> TInnerGetResponse:
_auto_invoke_function(
function_call,
custom_args=kwargs,
tool_map={t.name: t for t in chat_options._ai_tools or [] if isinstance(t, AIFunction)},
tool_map={t.name: t for t in chat_options._ai_tools or [] if isinstance(t, AIFunction)}, # type: ignore[reportPrivateUsage]
sequence_index=seq_idx,
request_index=attempt_idx,
)
@@ -203,7 +211,7 @@ def _tool_call_streaming(func: TInnerGetStreamingResponse) -> TInnerGetStreaming
_auto_invoke_function(
function_call,
custom_args=kwargs,
tool_map={t.name: t for t in chat_options._ai_tools or [] if isinstance(t, AIFunction)},
tool_map={t.name: t for t in chat_options._ai_tools or [] if isinstance(t, AIFunction)}, # type: ignore[reportPrivateUsage]
sequence_index=seq_idx,
request_index=attempt_idx,
)
python/packages/main/agent_framework/_logging.py
+2
View File
@@ -9,6 +9,8 @@ logging.basicConfig(
datefmt="%Y-%m-%d %H:%M:%S",
)
__all__ = ["get_logger"]
def get_logger(name: str = "agent_framework") -> logging.Logger:
"""Get a logger with the specified name, defaulting to 'agent_framework'.
python/packages/main/agent_framework/_pydantic.py
+2
View File
@@ -9,6 +9,8 @@ from pydantic_settings import BaseSettings, SettingsConfigDict
HttpsUrl = Annotated[AnyUrl, UrlConstraints(max_length=2083, allowed_schemes=["https"])]
__all__ = ["AFBaseModel", "AFBaseSettings", "HttpsUrl"]
class AFBaseModel(BaseModel):
"""Base class for all pydantic models in the Agent Framework."""
python/packages/main/agent_framework/_tools.py
+2
View File
@@ -7,6 +7,8 @@ from typing import Any, Generic, Protocol, TypeVar, runtime_checkable
from pydantic import BaseModel, create_model
__all__ = ["AIFunction", "AITool", "ai_function"]
@runtime_checkable
class AITool(Protocol):
python/packages/main/agent_framework/_types.py
+28
View File
@@ -75,6 +75,34 @@ KNOWN_MEDIA_TYPES = [
]
__all__ = [
"AIContent",
"AIContents",
"AgentRunResponse",
"AgentRunResponseUpdate",
"ChatFinishReason",
"ChatMessage",
"ChatOptions",
"ChatResponse",
"ChatResponseUpdate",
"ChatRole",
"ChatToolMode",
"DataContent",
"ErrorContent",
"FunctionCallContent",
"FunctionResultContent",
"GeneratedEmbeddings",
"SpeechToTextOptions",
"StructuredResponse",
"TextContent",
"TextReasoningContent",
"TextToSpeechOptions",
"UriContent",
"UsageContent",
"UsageDetails",
]
class UsageDetails(AFBaseModel):
"""Provides usage details about a request/response.
python/packages/main/agent_framework/azure/__init__.py
+10 -16
View File
@@ -1,34 +1,28 @@
# Copyright (c) Microsoft. All rights reserved.
import importlib
from typing import TYPE_CHECKING, Any
from typing import Any
PACKAGE_NAME = "agent_framework_azure"
PACKAGE_EXTRA = "azure"
_IMPORTS = {
"__version__": "agent_framework_azure",
"AzureChatClient": "agent_framework_azure",
"get_entra_auth_token": "agent_framework_azure",
}
_IMPORTS = [
"AzureChatClient",
"get_entra_auth_token",
"__version__",
]
def __getattr__(name: str) -> Any:
if name in _IMPORTS:
submod_name = _IMPORTS[name]
try:
module = importlib.import_module(submod_name, package=__name__)
return getattr(module, name)
return getattr(importlib.import_module(PACKAGE_NAME), name)
except ModuleNotFoundError as exc:
raise ModuleNotFoundError(
f"The '{PACKAGE_EXTRA}' extra is not installed, "
f"please do `pip install agent-framework[{PACKAGE_EXTRA}]`"
) from exc
raise AttributeError(f"module {__name__} has no attribute {name}")
raise AttributeError(f"Module {PACKAGE_NAME} has no attribute {name}.")
def __dir__() -> list[str]:
return list(_IMPORTS.keys())
if TYPE_CHECKING:
from agent_framework_azure import __version__ # noqa: F401
return _IMPORTS
python/packages/main/agent_framework/azure/__init__.pyi
+13
View File
@@ -0,0 +1,13 @@
# Copyright (c) Microsoft. All rights reserved.
from agent_framework_azure import (
AzureChatClient,
__version__,
get_entra_auth_token,
)
__all__ = [
"AzureChatClient",
"__version__",
"get_entra_auth_token",
]
python/packages/main/agent_framework/guard_rails.py
+2
View File
@@ -6,6 +6,8 @@ from typing import Generic, Protocol, TypeVar, runtime_checkable
TInput = TypeVar("TInput")
TResponse = TypeVar("TResponse")
__all__ = ["InputGuardrail", "OutputGuardrail"]
@runtime_checkable
class InputGuardrail(Protocol, Generic[TInput]):
python/packages/main/agent_framework/openai/__init__.py
+3 -9
View File
@@ -1,12 +1,6 @@
# Copyright (c) Microsoft. All rights reserved.
from ._chat_client import OpenAIChatClient
from ._shared import OpenAIHandler, OpenAIModelTypes, OpenAISettings
__all__ = [
"OpenAIChatClient",
"OpenAIHandler",
"OpenAIModelTypes",
"OpenAISettings",
]
from ._chat_client import * # noqa: F403
from ._exceptions import * # noqa: F403
from ._shared import * # noqa: F403
python/packages/main/agent_framework/openai/_chat_client.py
+2
View File
@@ -31,6 +31,8 @@ from .._types import (
from ..exceptions import ServiceInitializationError, ServiceInvalidResponseError
from ._shared import OpenAIConfigBase, OpenAIHandler, OpenAIModelTypes, OpenAISettings
__all__ = ["OpenAIChatClient"]
# Implements agent_framework.ChatClient protocol, through ChatClientBase
@use_tool_calling
python/packages/main/agent_framework/openai/exceptions.py → python/packages/main/agent_framework/openai/_exceptions.py
+2
View File
@@ -8,6 +8,8 @@ from openai import BadRequestError
from ..exceptions import ServiceContentFilterException
__all__ = ["ContentFilterResultSeverity", "OpenAIContentFilterException"]
class ContentFilterResultSeverity(Enum):
"""The severity of the content filter result."""
python/packages/main/agent_framework/openai/_shared.py
+8 -1
View File
@@ -26,7 +26,7 @@ from .._pydantic import AFBaseModel, AFBaseSettings
from .._types import ChatOptions, SpeechToTextOptions, TextToSpeechOptions
from ..exceptions import ServiceInitializationError, ServiceInvalidRequestError, ServiceResponseException
from ..telemetry import APP_INFO, USER_AGENT_KEY, prepend_agent_framework_to_user_agent
from .exceptions import OpenAIContentFilterException
from ._exceptions import OpenAIContentFilterException
logger: logging.Logger = get_logger("agent_framework.openai")
@@ -49,6 +49,13 @@ OPTION_TYPE = Union[
]
__all__ = [
"OpenAIHandler",
"OpenAIModelTypes",
"OpenAISettings",
]
class OpenAISettings(AFBaseSettings):
"""OpenAI model settings.
python/packages/main/agent_framework/telemetry.py
+7
View File
@@ -24,6 +24,13 @@ USER_AGENT_KEY: Final[str] = "User-Agent"
HTTP_USER_AGENT: Final[str] = "agent-framework-python"
AGENT_FRAMEWORK_USER_AGENT = f"{HTTP_USER_AGENT}/{version_info}"
__all__ = [
"AGENT_FRAMEWORK_USER_AGENT",
"APP_INFO",
"USER_AGENT_KEY",
"prepend_agent_framework_to_user_agent",
]
def prepend_agent_framework_to_user_agent(headers: dict[str, Any]) -> dict[str, Any]:
"""Prepend "agent-framework" to the User-Agent in the headers.