gpt_engineer/core/base_agent.py

"""
Base Agent Module

This module provides an abstract base class for an agent that interacts with code. It defines the interface
for agents capable of initializing and improving code based on a given prompt. Implementations of this class
are expected to provide concrete methods for these actions.

Classes:
    BaseAgent: Abstract base class for an agent that interacts with code.
"""
from abc import ABC, abstractmethod

from gpt_engineer.core.files_dict import FilesDict
from gpt_engineer.core.prompt import Prompt


class BaseAgent(ABC):
    """
    Abstract base class for an agent that interacts with code.

    Defines the interface for agents capable of initializing and improving code based on a given prompt.
    Implementations of this class are expected to provide concrete methods for these actions.
    """

    @abstractmethod
    def init(self, prompt: Prompt) -> FilesDict:
        pass

    @abstractmethod
    def improve(self, files_dict: FilesDict, prompt: Prompt) -> FilesDict:
        pass