Skip to main content

coding.base

CodeBlock​

class CodeBlock(BaseModel)

(Experimental) A class that represents a code block.

CodeResult​

class CodeResult(BaseModel)

(Experimental) A class that represents the result of a code execution.

CodeExtractor​

class CodeExtractor(Protocol)

(Experimental) A code extractor class that extracts code blocks from a message.

extract_code_blocks​

def extract_code_blocks(
    message: Union[str, List[Union[UserMessageTextContentPart,
                                   UserMessageImageContentPart]], None]
) -> List[CodeBlock]

(Experimental) Extract code blocks from a message.

Arguments:

  • message str - The message to extract code blocks from.

Returns:

  • List[CodeBlock] - The extracted code blocks.

CodeExecutor​

@runtime_checkable
class CodeExecutor(Protocol)

(Experimental) A code executor class that executes code blocks and returns the result.

code_extractor​

@property
def code_extractor() -> CodeExtractor

(Experimental) The code extractor used by this code executor.

execute_code_blocks​

def execute_code_blocks(code_blocks: List[CodeBlock]) -> CodeResult

(Experimental) Execute code blocks and return the result.

This method should be implemented by the code executor.

Arguments:

  • code_blocks List[CodeBlock] - The code blocks to execute.

Returns:

  • CodeResult - The result of the code execution.

restart​

def restart() -> None

(Experimental) Restart the code executor.

This method should be implemented by the code executor.

This method is called when the agent is reset.

IPythonCodeResult​

class IPythonCodeResult(CodeResult)

(Experimental) A code result class for IPython code executor.

CommandLineCodeResult​

class CommandLineCodeResult(CodeResult)

(Experimental) A code result class for command line code executor.