File size: 4,464 Bytes
fcaa164 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 |
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# ========= Copyright 2023-2024 @ CAMEL-AI.org. All Rights Reserved. =========
from typing import List, Literal, Optional, Union
from camel.interpreters import (
DockerInterpreter,
E2BInterpreter,
InternalPythonInterpreter,
JupyterKernelInterpreter,
SubprocessInterpreter,
)
from camel.toolkits import FunctionTool
from camel.toolkits.base import BaseToolkit
class CodeExecutionToolkit(BaseToolkit):
r"""A tookit for code execution.
Args:
sandbox (str): The environment type used to execute code.
verbose (bool): Whether to print the output of the code execution.
(default: :obj:`False`)
unsafe_mode (bool): If `True`, the interpreter runs the code
by `eval()` without any security check. (default: :obj:`False`)
import_white_list ( Optional[List[str]]): A list of allowed imports.
(default: :obj:`None`)
require_confirm (bool): Whether to require confirmation before executing code.
(default: :obj:`False`)
"""
def __init__(
self,
sandbox: Literal[
"internal_python", "jupyter", "docker", "subprocess", "e2b"
] = "internal_python",
verbose: bool = False,
unsafe_mode: bool = False,
import_white_list: Optional[List[str]] = None,
require_confirm: bool = False,
) -> None:
self.verbose = verbose
self.unsafe_mode = unsafe_mode
self.import_white_list = import_white_list or list()
# Type annotation for interpreter to allow all possible types
self.interpreter: Union[
InternalPythonInterpreter,
JupyterKernelInterpreter,
DockerInterpreter,
SubprocessInterpreter,
E2BInterpreter,
]
if sandbox == "internal_python":
self.interpreter = InternalPythonInterpreter(
unsafe_mode=self.unsafe_mode,
import_white_list=self.import_white_list,
)
elif sandbox == "jupyter":
self.interpreter = JupyterKernelInterpreter(
require_confirm=require_confirm,
print_stdout=self.verbose,
print_stderr=self.verbose,
)
elif sandbox == "docker":
self.interpreter = DockerInterpreter(
require_confirm=require_confirm,
print_stdout=self.verbose,
print_stderr=self.verbose,
)
elif sandbox == "subprocess":
self.interpreter = SubprocessInterpreter(
require_confirm=require_confirm,
print_stdout=self.verbose,
print_stderr=self.verbose,
)
elif sandbox == "e2b":
self.interpreter = E2BInterpreter(require_confirm=require_confirm)
else:
raise RuntimeError(
f"The sandbox type `{sandbox}` is not supported."
)
def execute_code(self, code: str) -> str:
r"""Execute a given code snippet.
Args:
code (str): The input code to the Code Interpreter tool call.
Returns:
str: The text output from the Code Interpreter tool call.
"""
output = self.interpreter.run(code, "python")
# ruff: noqa: E501
content = f"Executed the code below:\n```py\n{code}\n```\n> Executed Results:\n{output}"
if self.verbose:
print(content)
return content
def get_tools(self) -> List[FunctionTool]:
r"""Returns a list of FunctionTool objects representing the
functions in the toolkit.
Returns:
List[FunctionTool]: A list of FunctionTool objects
representing the functions in the toolkit.
"""
return [FunctionTool(self.execute_code)]
|