autogen_core.code_executor

class Alias(name: 'str', alias: 'str')

基类： object

alias: str

name: str

class CodeBlock(code: str, language: str)

基类： object

从代理消息中提取的代码块。

code: str

language: str

class CodeExecutor

基类： ABC, ComponentBase[BaseModel]

执行代码块并返回结果。

这是代码执行器的抽象基类。 它定义了执行代码块并返回结果的接口。 应该提供此类的具体实现，以在特定环境中执行代码块。 例如， DockerCommandLineCodeExecutor 在 Docker 容器中的命令行环境中执行代码块。

建议子类用作上下文管理器，以确保正确清理资源。 为此，请实现 start() 和 stop() 方法，这些方法将在进入和退出上下文管理器时调用。

component_type: ClassVar[ComponentType] = 'code_executor'

组件的逻辑类型。

abstract async execute_code_blocks(code_blocks: List[CodeBlock], cancellation_token: CancellationToken) → CodeResult

执行代码块并返回结果。

此方法应由代码执行器实现。

参数:

code_blocks (List[CodeBlock]) – 要执行的代码块。

返回:

CodeResult – 代码执行的结果。

引发:

• ValueError – 用户输入中的错误

• TimeoutError – 代码执行超时

• CancelledError – 执行期间引发的 CancellationToken

abstract async restart() → None

重新启动代码执行器。

此方法应由代码执行器实现。

当代理重置时调用此方法。

abstract async start() → None

启动代码执行器。

abstract async stop() → None

停止代码执行器并释放所有资源。

class CodeResult(exit_code: int, output: str)

基类： object

代码执行的结果。

exit_code: int

output: str

class FunctionWithRequirements(func: 'Callable[P, T]', python_packages: 'Sequence[str]' = <factory>, global_imports: 'Sequence[Import]' = <factory>)

基类: Generic[T, P]

classmethod from_callable(func: Callable[[P], T], python_packages: Sequence[str] = [], global_imports: Sequence[str | ImportFromModule | Alias] = []) → FunctionWithRequirements[T, P]

static from_str(func: str, python_packages: Sequence[str] = [], global_imports: Sequence[str | ImportFromModule | Alias] = []) → FunctionWithRequirementsStr

func: Callable[[P], T]

global_imports: Sequence[str | ImportFromModule | Alias]

python_packages: Sequence[str]

class FunctionWithRequirementsStr(func: 'str', python_packages: 'Sequence[str]' = [], global_imports: 'Sequence[Import]' = [])

基类： object

compiled_func: Callable[[...], Any]

func: str

global_imports: Sequence[str | ImportFromModule | Alias]

python_packages: Sequence[str]

class ImportFromModule(module: 'str', imports: 'Union[Tuple[Union[str, Alias], ...], List[Union[str, Alias]]]')

基类： object

imports: Tuple[str | Alias, ...]

module: str

with_requirements(python_packages: Sequence[str] = [], global_imports: Sequence[str | ImportFromModule | Alias] = []) → Callable[[Callable[[P], T]], FunctionWithRequirements[T, P]]

使用包和导入需求装饰一个函数，以用于代码执行环境。

此装饰器通过将其包装在 FunctionWithRequirements 对象中，使函数可用于在动态执行的代码块中引用，该对象跟踪其依赖项。当装饰的函数传递给代码执行器时，可以在执行的代码中按名称导入它，并自动处理所有依赖项。

参数:

• python_packages (Sequence[str], optional) – 函数所需的 Python 包。可以包括版本规范（例如，[“pandas>=1.0.0”]）。默认为 []。

• global_imports (Sequence[Import], optional) – 函数所需的 Import 语句。可以是字符串 (“numpy”)、ImportFromModule 对象或 Alias 对象。默认为 []。

返回:

Callable[[Callable[P, T]], FunctionWithRequirements[T, P]] – 一个装饰器，用于包装目标函数，在保留其功能的同时注册其依赖项。

例子

import tempfile
import asyncio
from autogen_core import CancellationToken
from autogen_core.code_executor import with_requirements, CodeBlock
from autogen_ext.code_executors.local import LocalCommandLineCodeExecutor
import pandas

@with_requirements(python_packages=["pandas"], global_imports=["pandas"])
def load_data() -> pandas.DataFrame:
    """Load some sample data.

    Returns:
        pandas.DataFrame: A DataFrame with sample data
    """
    data = {
        "name": ["John", "Anna", "Peter", "Linda"],
        "location": ["New York", "Paris", "Berlin", "London"],
        "age": [24, 13, 53, 33],
    }
    return pandas.DataFrame(data)

async def run_example():
    # The decorated function can be used in executed code
    with tempfile.TemporaryDirectory() as temp_dir:
        executor = LocalCommandLineCodeExecutor(work_dir=temp_dir, functions=[load_data])
        code = f"""from {executor.functions_module} import load_data

        # Use the imported function
        data = load_data()
        print(data['name'][0])"""

        result = await executor.execute_code_blocks(
            code_blocks=[CodeBlock(language="python", code=code)],
            cancellation_token=CancellationToken(),
        )
        print(result.output)  # Output: John

# Run the async example
asyncio.run(run_example())