ag2 0.9.5__py3-none-any.whl → 0.9.7__py3-none-any.whl

autogen/environments/python_environment.py

@@ -0,0 +1,134 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import subprocess
+from abc import ABC, abstractmethod
+from contextvars import ContextVar
+from typing import Any, Optional
+
+__all__ = ["PythonEnvironment"]
+
+
+class PythonEnvironment(ABC):
+    """Python execution environments base class"""
+
+    # Shared context variable for tracking the current environment
+    _current_python_environment: ContextVar["PythonEnvironment"] = ContextVar("_current_python_environment")
+
+    def __init__(self):
+        """
+        Initialize the Python environment.
+        """
+        self._token = None
+
+        # Set up the environment
+        self._setup_environment()
+
+    def __enter__(self):
+        """
+        Enter the environment context.
+        Sets this environment as the current one.
+        """
+        # Set this as the current Python environment in the context
+        self._token = PythonEnvironment._current_python_environment.set(self)
+
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """
+        Exit the environment context.
+        Resets the current environment and performs cleanup.
+        """
+        # Reset the context variable if this was the active environment
+        if self._token is not None:
+            PythonEnvironment._current_python_environment.reset(self._token)
+            self._token = None
+
+        # Clean up resources
+        self._cleanup_environment()
+
+    @abstractmethod
+    def _setup_environment(self) -> None:
+        """Set up the Python environment. Called by __enter__."""
+        pass
+
+    @abstractmethod
+    def _cleanup_environment(self) -> None:
+        """Clean up the Python environment. Called by __exit__."""
+        pass
+
+    @abstractmethod
+    def get_executable(self) -> str:
+        """
+        Get the path to the Python executable in this environment.
+
+        Returns:
+            The full path to the Python executable.
+        """
+        pass
+
+    @abstractmethod
+    async def execute_code(self, code: str, script_path: str, timeout: int = 30) -> dict[str, Any]:
+        """
+        Execute the given code in this environment.
+
+        Args:
+            code: The Python code to execute.
+            script_path: Path where the code should be saved before execution.
+            timeout: Maximum execution time in seconds.
+
+        Returns:
+            dict with execution results including stdout, stderr, and success status.
+        """
+        pass
+
+    # Utility method for subclasses to wrap (for async support)
+    def _write_to_file(self, script_path: str, content: str) -> None:
+        """
+        Write content to a file (blocking operation).
+
+        This is a helper method for use with asyncify in async contexts.
+
+        Args:
+            script_path: Path to the file to write.
+            content: Content to write to the file.
+        """
+        with open(script_path, "w") as f:
+            f.write(content)
+
+    # Utility method for subclasses to wrap (for async support)
+    def _run_subprocess(self, cmd: list[str], timeout: int) -> subprocess.CompletedProcess:
+        """
+        Run a subprocess (blocking operation).
+
+        This is a helper method for use with asyncify in async contexts.
+
+        Args:
+            cmd: Command to run as a list of strings.
+            timeout: Maximum execution time in seconds.
+
+        Returns:
+            CompletedProcess instance with results of the subprocess.
+        """
+        return subprocess.run(cmd, capture_output=True, text=True, timeout=timeout)
+
+    @classmethod
+    def get_current_python_environment(
+        cls, python_environment: Optional["PythonEnvironment"] = None
+    ) -> Optional["PythonEnvironment"]:
+        """
+        Get the current Python environment or the specified one if provided.
+
+        Args:
+            python_environment: Optional environment to return if specified.
+
+        Returns:
+            The current Python environment or None if none is active.
+        """
+        if python_environment is not None:
+            return python_environment
+        try:
+            return cls._current_python_environment.get()
+        except LookupError:
+            return None

autogen/environments/system_python_environment.py

@@ -0,0 +1,86 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import os
+import subprocess
+import sys
+from typing import Any, Optional
+
+from asyncer import asyncify
+
+from .python_environment import PythonEnvironment
+
+__all__ = ["SystemPythonEnvironment"]
+
+
+class SystemPythonEnvironment(PythonEnvironment):
+    """A Python environment using the system's Python installation."""
+
+    def __init__(
+        self,
+        executable: Optional[str] = None,
+    ):
+        """
+        Initialize a system Python environment.
+
+        Args:
+            executable: Optional path to a specific Python executable. If None, uses the current Python executable.
+        """
+        self._executable = executable or sys.executable
+        super().__init__()
+
+    def _setup_environment(self) -> None:
+        """Set up the system Python environment."""
+        # Verify the Python executable exists
+        if not os.path.exists(self._executable):
+            raise RuntimeError(f"Python executable not found at: {self._executable}")
+
+        logging.info(f"Using system Python at: {self._executable}")
+
+    def _cleanup_environment(self) -> None:
+        """Clean up the system Python environment."""
+        # No cleanup needed for system Python
+        pass
+
+    def get_executable(self) -> str:
+        """Get the path to the Python executable."""
+        return self._executable
+
+    async def execute_code(self, code: str, script_path: str, timeout: int = 30) -> dict[str, Any]:
+        """Execute code using the system Python."""
+        try:
+            # Get the Python executable
+            python_executable = self.get_executable()
+
+            # Verify the executable exists
+            if not os.path.exists(python_executable):
+                return {"success": False, "error": f"Python executable not found at {python_executable}"}
+
+            # Ensure the directory for the script exists
+            script_dir = os.path.dirname(script_path)
+            if script_dir:
+                os.makedirs(script_dir, exist_ok=True)
+
+            # Write the code to the script file using asyncify (from base class)
+            await asyncify(self._write_to_file)(script_path, code)
+
+            logging.info(f"Wrote code to {script_path}")
+
+            try:
+                # Execute directly with subprocess using asyncify for better reliability
+                result = await asyncify(self._run_subprocess)([python_executable, script_path], timeout)
+
+                # Main execution result
+                return {
+                    "success": result.returncode == 0,
+                    "stdout": result.stdout,
+                    "stderr": result.stderr,
+                    "returncode": result.returncode,
+                }
+            except subprocess.TimeoutExpired:
+                return {"success": False, "error": f"Execution timed out after {timeout} seconds"}
+
+        except Exception as e:
+            return {"success": False, "error": f"Execution error: {str(e)}"}

autogen/environments/venv_python_environment.py

@@ -0,0 +1,224 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import logging
+import os
+import subprocess
+import sys
+import tempfile
+from typing import Any, Optional
+
+from asyncer import asyncify
+
+from .python_environment import PythonEnvironment
+
+__all__ = ["VenvPythonEnvironment"]
+
+
+class VenvPythonEnvironment(PythonEnvironment):
+    """A Python environment using a virtual environment (venv)."""
+
+    def __init__(
+        self,
+        python_version: Optional[str] = None,
+        python_path: Optional[str] = None,
+        venv_path: Optional[str] = None,
+    ):
+        """
+        Initialize a virtual environment for Python execution.
+
+        If you pass in a venv_path the path will be checked for a valid venv. If the venv doesn't exist it will be created using the python_version or python_path provided.
+
+        If the python_version or python_path is provided and the venv_path is not, a temporary directory will be created for venv and it will be setup with the provided python version.
+
+        If python_path is provided, it will take precedence over python_version.
+
+        The python version will not be installed if it doesn't exist and a RuntimeError will be raised.
+
+        Args:
+            python_version: The Python version to use (e.g., "3.11"), otherwise defaults to the current executing Python version. Ignored if venv_path is provided and has a valid environment already.
+            python_path: Optional direct path to a Python executable to use (must include the executable). Takes precedence over python_version if both are provided.
+            venv_path: Optional path for the virtual environment, will create it if it doesn't exist. If None, creates a temp directory.
+        """
+        self.python_version = python_version
+        self.python_path = python_path
+        self.venv_path = venv_path
+        self.created_venv = False
+        self._executable = None
+        super().__init__()
+
+    def _setup_environment(self) -> None:
+        """Set up the virtual environment."""
+        # Create a venv directory if not provided
+        if self.venv_path is None:
+            self.venv_path = tempfile.mkdtemp(prefix="ag2_python_env_")
+            self.created_venv = True
+
+            # Determine the python version, getting it from the venv if it already has one
+            base_python = self._get_python_executable_for_version()
+            needs_creation = True
+        else:
+            # If venv_path is provided, check if it's already a valid venv
+            if os.name == "nt":  # Windows
+                venv_python = os.path.join(self.venv_path, "Scripts", "python.exe")
+            else:  # Unix-like (Mac/Linux)
+                venv_python = os.path.join(self.venv_path, "bin", "python")
+
+            if os.path.exists(venv_python) and os.access(venv_python, os.X_OK):
+                # Valid venv already exists, just use it
+                self._executable = venv_python
+                logging.info(f"Using existing virtual environment at {self.venv_path}")
+                needs_creation = False
+            else:
+                # Path exists but not a valid venv, or doesn't exist
+                if not os.path.exists(self.venv_path):
+                    os.makedirs(self.venv_path, exist_ok=True)
+                self.created_venv = True
+                base_python = sys.executable
+                needs_creation = True
+
+        # Only create the venv if needed
+        if needs_creation:
+            logging.info(f"Creating virtual environment at {self.venv_path} using {base_python}")
+
+            try:
+                # Create the virtual environment
+                _ = subprocess.run(
+                    [base_python, "-m", "venv", "--system-site-packages", self.venv_path],
+                    check=True,
+                    stdout=subprocess.PIPE,
+                    stderr=subprocess.PIPE,
+                    text=True,
+                )
+
+                # Determine the Python executable path
+                if os.name == "nt":  # Windows
+                    self._executable = os.path.join(self.venv_path, "Scripts", "python.exe")
+                else:  # Unix-like (Mac/Linux)
+                    self._executable = os.path.join(self.venv_path, "bin", "python")
+
+                # Verify the executable exists
+                if not os.path.exists(self._executable):
+                    raise RuntimeError(
+                        f"Virtual environment created but Python executable not found at {self._executable}"
+                    )
+
+            except subprocess.CalledProcessError as e:
+                raise RuntimeError(f"Failed to create virtual environment: {e.stderr}") from e
+
+    def _cleanup_environment(self) -> None:
+        """Clean up the virtual environment."""
+        # Note: We intentionally don't clean up the venv here to allow
+        # tools to continue using it after the context exits.
+        pass
+
+    def get_executable(self) -> str:
+        """Get the path to the Python executable in the virtual environment."""
+        if not self._executable or not os.path.exists(self._executable):
+            raise RuntimeError("Virtual environment Python executable not found")
+        return self._executable
+
+    async def execute_code(self, code: str, script_path: str, timeout: int = 30) -> dict[str, Any]:
+        """Execute code in the virtual environment."""
+        try:
+            # Get the Python executable
+            python_executable = self.get_executable()
+
+            # Verify the executable exists
+            if not os.path.exists(python_executable):
+                return {"success": False, "error": f"Python executable not found at {python_executable}"}
+
+            # Ensure the directory for the script exists
+            script_dir = os.path.dirname(script_path)
+            if script_dir:
+                os.makedirs(script_dir, exist_ok=True)
+
+            # Write the code to the script file using asyncify (from base class)
+            await asyncify(self._write_to_file)(script_path, code)
+
+            logging.info(f"Wrote code to {script_path}")
+
+            try:
+                # Execute directly with subprocess using asyncify for better reliability
+                result = await asyncify(self._run_subprocess)([python_executable, script_path], timeout)
+
+                # Main execution result
+                return {
+                    "success": result.returncode == 0,
+                    "stdout": result.stdout,
+                    "stderr": result.stderr,
+                    "returncode": result.returncode,
+                }
+            except subprocess.TimeoutExpired:
+                return {"success": False, "error": f"Execution timed out after {timeout} seconds"}
+
+        except Exception as e:
+            return {"success": False, "error": f"Execution error: {str(e)}"}
+
+    def _get_python_executable_for_version(self) -> str:
+        """Get the Python executable for the specified version and verify it can create a venv."""
+        # If a specific path is provided, use it directly
+        if self.python_path:
+            if not os.path.exists(self.python_path) or not os.access(self.python_path, os.X_OK):
+                raise RuntimeError(f"Python executable not found at {self.python_path}")
+            return self.python_path
+
+        # If no specific version is requested, use the current Python
+        if not self.python_version:
+            return sys.executable
+
+        potential_executables = []
+
+        # Try to find a specific Python version using pyenv if available
+        try:
+            pyenv_result = subprocess.run(
+                ["pyenv", "which", f"python{self.python_version}"],
+                check=True,
+                stdout=subprocess.PIPE,
+                stderr=subprocess.PIPE,
+                text=True,
+            )
+            potential_executables.append(pyenv_result.stdout.strip())
+        except (subprocess.SubprocessError, FileNotFoundError):
+            pass
+
+        # Try common system paths based on platform
+        if os.name == "nt":  # Windows
+            potential_executables.extend([
+                f"C:\\Python{self.python_version.replace('.', '')}\\python.exe",
+                f"C:\\Program Files\\Python{self.python_version.replace('.', '')}\\python.exe",
+                f"C:\\Program Files (x86)\\Python{self.python_version.replace('.', '')}\\python.exe",
+            ])
+        else:  # Unix-like (Mac and Linux)
+            # Add more paths that might exist on macOS
+            potential_executables.extend([
+                f"/usr/bin/python{self.python_version}",
+                f"/usr/local/bin/python{self.python_version}",
+                f"/opt/homebrew/bin/python{self.python_version}",  # Homebrew on Apple Silicon
+                f"/opt/python/bin/python{self.python_version}",
+            ])
+
+        # Try each potential path and verify it can create a venv
+        for path in potential_executables:
+            if os.path.exists(path) and os.access(path, os.X_OK):
+                # Verify this Python can create a venv
+                try:
+                    test_result = subprocess.run(
+                        [path, "-m", "venv", "--help"],
+                        check=False,  # Don't raise exception
+                        stdout=subprocess.PIPE,
+                        stderr=subprocess.PIPE,
+                        text=True,
+                        timeout=5,  # Add timeout for safety
+                    )
+                    if test_result.returncode == 0:
+                        # Successfully found a valid Python executable
+                        return path
+                except (subprocess.SubprocessError, FileNotFoundError):
+                    continue
+
+        # If we couldn't find the specified version, raise an exception
+        raise RuntimeError(
+            f"Python {self.python_version} not found or cannot create virtual environments. Provide a python_path to use a specific Python executable."
+        )

autogen/environments/working_directory.py

@@ -0,0 +1,75 @@
+# Copyright (c) 2023 - 2025, AG2ai, Inc., AG2ai open-source projects maintainers and core contributors
+#
+# SPDX-License-Identifier: Apache-2.0
+
+import contextlib
+import os
+import shutil
+import tempfile
+from contextvars import ContextVar
+from typing import Optional
+
+__all__ = ["WorkingDirectory"]
+
+
+class WorkingDirectory:
+    """Context manager for changing the current working directory."""
+
+    _current_working_directory: ContextVar["WorkingDirectory"] = ContextVar("_current_working_directory")
+
+    def __init__(self, path: str):
+        """
+        Initialize with a directory path.
+
+        Args:
+            path: The directory path to change to.
+        """
+        self.path = path
+        self.original_path = None
+        self.created_tmp = False
+        self._token = None
+
+    def __enter__(self):
+        """Change to the specified directory and return self."""
+        self.original_path = os.getcwd()
+        if self.path:
+            os.makedirs(self.path, exist_ok=True)
+            os.chdir(self.path)
+
+        # Set this as the current working directory in the context
+        self._token = WorkingDirectory._current_working_directory.set(self)
+
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        """Change back to the original directory and clean up if necessary."""
+        # Reset the context variable if this was the active working directory
+        if self._token is not None:
+            WorkingDirectory._current_working_directory.reset(self._token)
+            self._token = None
+
+        if self.original_path:
+            os.chdir(self.original_path)
+        if self.created_tmp and self.path and os.path.exists(self.path):
+            with contextlib.suppress(Exception):
+                shutil.rmtree(self.path)
+
+    @classmethod
+    def create_tmp(cls):
+        """Create a temporary directory and return a WorkingDirectory instance for it."""
+        tmp_dir = tempfile.mkdtemp(prefix="ag2_work_dir_")
+        instance = cls(tmp_dir)
+        instance.created_tmp = True
+        return instance
+
+    @classmethod
+    def get_current_working_directory(
+        cls, working_directory: Optional["WorkingDirectory"] = None
+    ) -> Optional["WorkingDirectory"]:
+        """Get the current working directory or the specified one if provided."""
+        if working_directory is not None:
+            return working_directory
+        try:
+            return cls._current_working_directory.get()
+        except LookupError:
+            return None

autogen/llm_config.py

@@ -9,7 +9,7 @@ from abc import ABC, abstractmethod
 from collections.abc import Iterable
 from contextvars import ContextVar
 from pathlib import Path
-from typing import TYPE_CHECKING, Annotated, Any, Mapping, Optional, Type, TypeVar, Union
+from typing import TYPE_CHECKING, Annotated, Any, Literal, Mapping, Optional, Type, TypeVar, Union
 
 from httpx import Client as httpxClient
 from pydantic import BaseModel, ConfigDict, Field, HttpUrl, SecretStr, ValidationInfo, field_serializer, field_validator
@@ -268,6 +268,7 @@ class LLMConfig(metaclass=MetaLLMConfig):
                     list[Annotated[Union[llm_config_classes], Field(discriminator="api_type")]],
                     Field(default_factory=list, min_length=1),
                 ]
+                routing_method: Optional[Literal["fixed_order", "round_robin"]] = None
 
                 # Following field is configuration for pydantic to disallow extra fields
                 model_config = ConfigDict(extra="forbid")
@@ -302,13 +303,15 @@ class LLMConfigEntry(BaseModel, ABC):
     @field_validator("base_url", mode="before")
     @classmethod
     def check_base_url(cls, v: Any, info: ValidationInfo) -> Any:
+        if v is None:  # Handle None case explicitly
+            return None
         if not str(v).startswith("https://") and not str(v).startswith("http://"):
             v = f"http://{str(v)}"
         return v
 
-    @field_serializer("base_url")
+    @field_serializer("base_url", when_used="unless-none")  # Ensure serializer also respects None
     def serialize_base_url(self, v: Any) -> Any:
-        return str(v)
+        return str(v) if v is not None else None
 
     @field_serializer("api_key", when_used="unless-none")
     def serialize_api_key(self, v: SecretStr) -> Any:

autogen/logger/sqlite_logger.py

@@ -293,7 +293,7 @@ class SqliteLogger(BaseLogger):
             client_id,
             wrapper_id,
             self.session_id,
-            json.dumps(request),
+            json.dumps(to_dict(request)),
             response_messages,
             is_cached,
             cost,

autogen/mcp/mcp_proxy/mcp_proxy.py

@@ -129,12 +129,12 @@ class MCPProxy:
         return mcp
 
     def _process_params(
-        self, path: str, func: Callable[[Any], Any], **kwargs: Any
+        self, process_path: str, func: Callable[[Any], Any], **kwargs: Any
     ) -> tuple[str, dict[str, Any], dict[str, Any]]:
-        path = MCPProxy._convert_camel_case_within_braces_to_snake(path)
-        q_params, path_params, body, security = MCPProxy._get_params(path, func)
+        process_path = MCPProxy._convert_camel_case_within_braces_to_snake(process_path)
+        q_params, path_params, body, security = MCPProxy._get_params(process_path, func)
 
-        expanded_path = path.format(**{p: kwargs[p] for p in path_params})
+        expanded_path = process_path.format(**{p: kwargs[p] for p in path_params})
 
         url = self._servers[0]["url"] + expanded_path
 

autogen/oai/client.py

@@ -246,6 +246,12 @@ class OpenAILLMConfigEntry(LLMConfigEntry):
     price: Optional[list[float]] = Field(default=None, min_length=2, max_length=2)
     tool_choice: Optional[Literal["none", "auto", "required"]] = None
     user: Optional[str] = None
+
+    # ⏺ The extra_body parameter flows from OpenAILLMConfigEntry to the LLM request through this path:
+    #   1. Config Definition: extra_body is defined in OpenAILLMConfigEntry (autogen/oai/client.py:248)
+    #   2. Parameter Classification: It's classified as an OpenAI client parameter (not AG2-specific) via the openai_kwargs property (autogen/oai/client.py:752-758)
+    #   3. Request Separation: In _separate_create_config() (autogen/oai/client.py:842), extra_body goes into create_config since it's not in the extra_kwargs set.
+    #   4. API Call: The create_config becomes params and gets passed directly to OpenAI's create() method via **params (autogen/oai/client.py:551,658)
     extra_body: Optional[dict[str, Any]] = (
         None  # For VLLM - See here: https://docs.vllm.ai/en/latest/serving/openai_compatible_server.html#extra-parameters
     )
@@ -806,17 +812,29 @@ class OpenAIWrapper:
         self._clients: list[ModelClient] = []
         self._config_list: list[dict[str, Any]] = []
 
+        # Determine routing_method from base_config only.
+        self.routing_method = base_config.get("routing_method") or "fixed_order"
+        self._round_robin_index = 0
+
+        # Remove routing_method from extra_kwargs after it has been used to set self.routing_method
+        # This ensures it's not part of the individual client configurations that are based on extra_kwargs.
+        extra_kwargs.pop("routing_method", None)
+
         if config_list:
             config_list = [config.copy() for config in config_list]  # make a copy before modifying
-            for config in config_list:
-                self._register_default_client(config, openai_config)  # could modify the config
-                self._config_list.append({
-                    **extra_kwargs,
-                    **{k: v for k, v in config.items() if k not in self.openai_kwargs},
-                })
+            for config_item in config_list:
+                self._register_default_client(config_item, openai_config)
+                # Construct current_config_extra_kwargs using the cleaned extra_kwargs
+                # (which doesn't have routing_method from base_config)
+                # and specific non-openai kwargs from config_item.
+                config_item_specific_extras = {k: v for k, v in config_item.items() if k not in self.openai_kwargs}
+                self._config_list.append({**extra_kwargs, **config_item_specific_extras})
         else:
+            # For a single config passed via base_config (already in extra_kwargs)
             self._register_default_client(extra_kwargs, openai_config)
+            # extra_kwargs has already had routing_method popped.
             self._config_list = [extra_kwargs]
+
         self.wrapper_id = id(self)
 
     def _separate_openai_config(self, config: dict[str, Any]) -> tuple[dict[str, Any], dict[str, Any]]:
@@ -1074,7 +1092,16 @@ class OpenAIWrapper:
             raise RuntimeError(
                 f"Model client(s) {non_activated} are not activated. Please register the custom model clients using `register_model_client` or filter them out form the config list."
             )
-        for i, client in enumerate(self._clients):
+
+        ordered_clients_indices = list(range(len(self._clients)))
+        if self.routing_method == "round_robin" and len(self._clients) > 0:
+            ordered_clients_indices = (
+                ordered_clients_indices[self._round_robin_index :] + ordered_clients_indices[: self._round_robin_index]
+            )
+            self._round_robin_index = (self._round_robin_index + 1) % len(self._clients)
+
+        for i in ordered_clients_indices:
+            client = self._clients[i]
             # merge the input config with the i-th config in the config list
             full_config = {**config, **self._config_list[i]}
             # separate the config into create_config and extra_kwargs

autogen/oai/gemini.py

@@ -126,6 +126,7 @@ class GeminiClient:
     PARAMS_MAPPING = {
         "max_tokens": "max_output_tokens",
         # "n": "candidate_count", # Gemini supports only `n=1`
+        "seed": "seed",
         "stop_sequences": "stop_sequences",
         "temperature": "temperature",
         "top_p": "top_p",