Python: Add load_dotenv() to samples for .env file support (#4043)

* Initial plan * Add load_dotenv() to 303 Python samples for environment variable loading Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Update SAMPLE_GUIDELINES.md to document load_dotenv() requirement Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Update samples README.md to document .env file usage Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Run ruff format on all changed sample files Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Clarify load_dotenv() usage in README - local dev vs production Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Remove deprecated getting_started folder as requested Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Document env_file_path parameter for per-client configuration Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Merge main branch to resolve conflicts Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Fix run_evaluation.py file that was empty in merge commit Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Remove dotnet changes from merge - out of scope for this PR Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Remove package and test changes from merge - only sample changes needed Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Remove test_func_utils.py - only sample changes needed Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Revert sample files not in original changeset - keep only load_dotenv additions Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Move load_dotenv() outside snippet tag in 06_host_your_agent.py Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Fix comment placement - move load_dotenv before code comments Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Fix load_dotenv() placement across all samples - after docstring, before code comments Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Merge latest main branch with load_dotenv changes Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Remove non-sample changes from merge - keep only load_dotenv additions Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Revert non-load_dotenv sample changes from merge Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Fix run_evaluation.py - use main's improved version (file already had load_dotenv) Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> * Manual update * Manual update 2 * Fix Role usage and load_dotenv placement per PR review feedback Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * Fix Role usage - use string literals not enum attributes Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * Fix SAMPLE_GUIDELINES.md example - load_dotenv before docstring per guidance Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * Move load_dotenv() before docstrings in all samples per SAMPLE_GUIDELINES ordering Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * Address PR review: rename files, fix placement, add session usage, remove note Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> * Update Redis README to reference renamed file redis_history_provider.py Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: TaoChenOSU <12570346+TaoChenOSU@users.noreply.github.com> Co-authored-by: Tao Chen <taochen@microsoft.com> Co-authored-by: eavanvalkenburg <13749212+eavanvalkenburg@users.noreply.github.com> Co-authored-by: Eduard van Valkenburg <eavanvalkenburg@users.noreply.github.com>
2026-06-16 21:04:09 +08:00 · 2026-02-19 10:55:13 +00:00
parent 3ea9c5fa5d
commit b05fc9e849
317 changed files with 1654 additions and 479 deletions
@@ -7,9 +7,13 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants Basic Example

@@ -7,9 +7,13 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistant Provider Methods Example

@@ -5,6 +5,7 @@ import os

 from agent_framework import AgentResponseUpdate, ChatResponseUpdate
 from agent_framework.openai import OpenAIAssistantProvider, OpenAIAssistantsClient
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from openai.types.beta.threads.runs import (
    CodeInterpreterToolCallDelta,
@@ -14,6 +15,9 @@ from openai.types.beta.threads.runs import (
 )
 from openai.types.beta.threads.runs.code_interpreter_tool_call_delta import CodeInterpreter

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants with Code Interpreter Example

@@ -7,9 +7,13 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants with Existing Assistant Example

@@ -18,7 +22,9 @@ using the provider's get_agent() and as_agent() methods.
 """


-# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production; see samples/02-agents/tools/function_tool_with_approval.py and samples/02-agents/tools/function_tool_with_approval_and_sessions.py.
+# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production;
+# see samples/02-agents/tools/function_tool_with_approval.py
+# and samples/02-agents/tools/function_tool_with_approval_and_sessions.py.
@tool(approval_mode="never_require")
 def get_weather(
    location: Annotated[str, Field(description="The location to get the weather for.")],
@@ -7,9 +7,13 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants with Explicit Settings Example

@@ -5,8 +5,12 @@ import os

 from agent_framework import Content
 from agent_framework.openai import OpenAIAssistantProvider, OpenAIAssistantsClient
+from dotenv import load_dotenv
 from openai import AsyncOpenAI

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants with File Search Example

@@ -8,9 +8,13 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants with Function Tools Example

@@ -19,7 +23,9 @@ showing both agent-level and query-level tool configuration patterns.
 """


-# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production; see samples/02-agents/tools/function_tool_with_approval.py and samples/02-agents/tools/function_tool_with_approval_and_sessions.py.
+# NOTE: approval_mode="never_require" is for sample brevity. Use "always_require" in production;
+# see samples/02-agents/tools/function_tool_with_approval.py
+# and samples/02-agents/tools/function_tool_with_approval_and_sessions.py.
@tool(approval_mode="never_require")
 def get_weather(
    location: Annotated[str, Field(description="The location to get the weather for.")],
@@ -4,9 +4,13 @@ import asyncio
 import os

 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import BaseModel, ConfigDict

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistant Provider Response Format Example

@@ -7,9 +7,13 @@ from typing import Annotated

 from agent_framework import AgentSession, tool
 from agent_framework.openai import OpenAIAssistantProvider
+from dotenv import load_dotenv
 from openai import AsyncOpenAI
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Assistants with Session Management Example

@@ -6,6 +6,10 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Chat Client Basic Example
@@ -7,8 +7,12 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Chat Client with Explicit Settings Example

@@ -7,8 +7,12 @@ from typing import Annotated

 from agent_framework import Agent, tool
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Chat Client with Function Tools Example

@@ -4,6 +4,10 @@ import asyncio

 from agent_framework import Agent, MCPStreamableHTTPTool
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Chat Client with Local MCP Example
@@ -4,6 +4,10 @@ import asyncio
 import json

 from agent_framework.openai import OpenAIChatClient, OpenAIChatOptions
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Chat Client Runtime JSON Schema Example
@@ -6,8 +6,12 @@ from typing import Annotated

 from agent_framework import Agent, AgentSession, InMemoryHistoryProvider, tool
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Chat Client with Session Management Example

@@ -4,6 +4,10 @@ import asyncio

 from agent_framework import Agent
 from agent_framework.openai import OpenAIChatClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Chat Client with Web Search Example
@@ -16,8 +16,12 @@ from agent_framework import (
    tool,
 )
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client Basic Example

@@ -4,6 +4,10 @@ import asyncio

 from agent_framework import Content
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client Image Analysis Example
@@ -8,6 +8,10 @@ from pathlib import Path

 from agent_framework import Content
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client Image Generation Example
@@ -3,6 +3,10 @@
 import asyncio

 from agent_framework.openai import OpenAIResponsesClient, OpenAIResponsesOptions
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client Reasoning Example
@@ -8,6 +8,10 @@ from pathlib import Path
 import anyio
 from agent_framework import Content
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """OpenAI Responses Client Streaming Image Generation Example

@@ -75,10 +79,7 @@ async def main():
            # represents a progressive refinement, with the last one being the finished result.
            if content.type == "image_generation_tool_result" and isinstance(content.outputs, Content):
                image_output: Content = content.outputs
-                if (
-                    image_output.type == "data"
-                    and image_output.additional_properties.get("is_partial_image")
-                ):
+                if image_output.type == "data" and image_output.additional_properties.get("is_partial_image"):
                    print(f"     Image {image_count} received")

                    # Extract file extension from media_type (e.g., "image/png" -> "png")
@@ -5,6 +5,10 @@ from collections.abc import Awaitable, Callable

 from agent_framework import FunctionInvocationContext
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client Agent-as-Tool Example
@@ -7,6 +7,10 @@ from agent_framework import (
    Content,
 )
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client with Code Interpreter Example
@@ -6,8 +6,12 @@ import tempfile

 from agent_framework import Agent
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
 from openai import AsyncOpenAI

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client with Code Interpreter and Files Example

@@ -7,8 +7,12 @@ from typing import Annotated

 from agent_framework import tool
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client with Explicit Settings Example

@@ -4,6 +4,10 @@ import asyncio

 from agent_framework import Agent
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client with File Search Example
@@ -7,8 +7,12 @@ from typing import Annotated

 from agent_framework import Agent, tool
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client with Function Tools Example

@@ -7,15 +7,18 @@ from agent_framework import Agent
 from agent_framework.openai import OpenAIResponsesClient
 from dotenv import load_dotenv

+if TYPE_CHECKING:
+    from agent_framework import AgentSession, SupportsAgentRun
+
+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client with Hosted MCP Example

 This sample demonstrates integrating hosted Model Context Protocol (MCP) tools with
 OpenAI Responses Client, including user approval workflows for function call security.
 """
-load_dotenv()  # Load environment variables from .env file if present
-if TYPE_CHECKING:
-    from agent_framework import AgentSession, SupportsAgentRun


 async def handle_approvals_without_session(query: str, agent: "SupportsAgentRun"):
@@ -4,6 +4,10 @@ import asyncio

 from agent_framework import Agent, MCPStreamableHTTPTool
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client with Local MCP Example
@@ -4,6 +4,10 @@ import asyncio
 import json

 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Chat Client Runtime JSON Schema Example
@@ -6,8 +6,12 @@ from typing import Annotated

 from agent_framework import Agent, AgentSession, tool
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
 from pydantic import Field

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client with Session Management Example

@@ -4,8 +4,12 @@ import asyncio

 from agent_framework import AgentResponse
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
 from pydantic import BaseModel

+# Load environment variables from .env file
+load_dotenv()
+
 """
 OpenAI Responses Client with Structured Output Example

@@ -4,6 +4,10 @@ import asyncio

 from agent_framework import Agent
 from agent_framework.openai import OpenAIResponsesClient
+from dotenv import load_dotenv
+
+# Load environment variables from .env file
+load_dotenv()

 """
 OpenAI Responses Client with Web Search Example