Merge pull request #497 from mannaandpoem/incremental_development

add increment development function

metagpt/actions/design_api.py

@@ -14,7 +14,14 @@
 from typing import Optional
 
 from metagpt.actions import Action, ActionOutput
-from metagpt.actions.design_api_an import DESIGN_API_NODE
+from metagpt.actions.design_api_an import (
+    DATA_STRUCTURES_AND_INTERFACES,
+    DESIGN_API_NODE,
+    PROGRAM_CALL_FLOW,
+    REFINED_DATA_STRUCTURES_AND_INTERFACES,
+    REFINED_DESIGN_NODE,
+    REFINED_PROGRAM_CALL_FLOW,
+)
 from metagpt.config import CONFIG
 from metagpt.const import (
     DATA_API_DESIGN_FILE_REPO,
@@ -82,7 +89,7 @@ async def _new_system_design(self, context, schema=CONFIG.prompt_schema):
 
     async def _merge(self, prd_doc, system_design_doc, schema=CONFIG.prompt_schema):
         context = NEW_REQ_TEMPLATE.format(old_design=system_design_doc.content, context=prd_doc.content)
-        node = await DESIGN_API_NODE.fill(context=context, llm=self.llm, schema=schema)
+        node = await REFINED_DESIGN_NODE.fill(context=context, llm=self.llm, schema=schema)
         system_design_doc.content = node.instruct_content.model_dump_json()
         return system_design_doc
 
@@ -109,7 +116,7 @@ async def _update_system_design(self, filename, prds_file_repo, system_design_fi
     @staticmethod
     async def _save_data_api_design(design_doc):
         m = json.loads(design_doc.content)
-        data_api_design = m.get("Data structures and interfaces")
+        data_api_design = m.get(DATA_STRUCTURES_AND_INTERFACES.key) or m.get(REFINED_DATA_STRUCTURES_AND_INTERFACES.key)
         if not data_api_design:
             return
         pathname = CONFIG.git_repo.workdir / DATA_API_DESIGN_FILE_REPO / Path(design_doc.filename).with_suffix("")
@@ -119,7 +126,7 @@ async def _save_data_api_design(design_doc):
     @staticmethod
     async def _save_seq_flow(design_doc):
         m = json.loads(design_doc.content)
-        seq_flow = m.get("Program call flow")
+        seq_flow = m.get(PROGRAM_CALL_FLOW.key) or m.get(REFINED_PROGRAM_CALL_FLOW.key)
         if not seq_flow:
             return
         pathname = CONFIG.git_repo.workdir / Path(SEQ_FLOW_FILE_REPO) / Path(design_doc.filename).with_suffix("")

metagpt/actions/design_api_an.py

@@ -8,6 +8,7 @@
 from typing import List
 
 from metagpt.actions.action_node import ActionNode
+from metagpt.logs import logger
 from metagpt.utils.mermaid import MMC1, MMC2
 
 IMPLEMENTATION_APPROACH = ActionNode(
@@ -17,6 +18,15 @@
     example="We will ...",
 )
 
+REFINED_IMPLEMENTATION_APPROACH = ActionNode(
+    key="Refined Implementation Approach",
+    expected_type=str,
+    instruction="Update and extend the original implementation approach to reflect the evolving challenges and "
+    "requirements due to incremental development. Outline the steps involved in the implementation process with the "
+    "detailed strategies.",
+    example="We will refine ...",
+)
+
 PROJECT_NAME = ActionNode(
     key="Project name", expected_type=str, instruction="The project name with underline", example="game_2048"
 )
@@ -28,6 +38,14 @@
     example=["main.py", "game.py"],
 )
 
+REFINED_FILE_LIST = ActionNode(
+    key="Refined File list",
+    expected_type=List[str],
+    instruction="Update and expand the original file list including only relative paths. Up to 2 files can be added."
+    "Ensure that the refined file list reflects the evolving structure of the project.",
+    example=["main.py", "game.py", "new_feature.py"],
+)
+
 DATA_STRUCTURES_AND_INTERFACES = ActionNode(
     key="Data structures and interfaces",
     expected_type=str,
@@ -37,6 +55,16 @@
     example=MMC1,
 )
 
+REFINED_DATA_STRUCTURES_AND_INTERFACES = ActionNode(
+    key="Refined Data structures and interfaces",
+    expected_type=str,
+    instruction="Update and extend the existing mermaid classDiagram code syntax to incorporate new classes, "
+    "methods (including __init__), and functions with precise type annotations. Delineate additional "
+    "relationships between classes, ensuring clarity and adherence to PEP8 standards."
+    "Retain content that is not related to incremental development but important for consistency and clarity.",
+    example=MMC1,
+)
+
 PROGRAM_CALL_FLOW = ActionNode(
     key="Program call flow",
     expected_type=str,
@@ -45,6 +73,16 @@
     example=MMC2,
 )
 
+REFINED_PROGRAM_CALL_FLOW = ActionNode(
+    key="Refined Program call flow",
+    expected_type=str,
+    instruction="Extend the existing sequenceDiagram code syntax with detailed information, accurately covering the"
+    "CRUD and initialization of each object. Ensure correct syntax usage and reflect the incremental changes introduced"
+    "in the classes and API defined above. "
+    "Retain content that is not related to incremental development but important for consistency and clarity.",
+    example=MMC2,
+)
+
 ANYTHING_UNCLEAR = ActionNode(
     key="Anything UNCLEAR",
     expected_type=str,
@@ -61,4 +99,24 @@
     ANYTHING_UNCLEAR,
 ]
 
+REFINED_NODES = [
+    REFINED_IMPLEMENTATION_APPROACH,
+    REFINED_FILE_LIST,
+    REFINED_DATA_STRUCTURES_AND_INTERFACES,
+    REFINED_PROGRAM_CALL_FLOW,
+    ANYTHING_UNCLEAR,
+]
+
 DESIGN_API_NODE = ActionNode.from_children("DesignAPI", NODES)
+REFINED_DESIGN_NODE = ActionNode.from_children("RefinedDesignAPI", REFINED_NODES)
+
+
+def main():
+    prompt = DESIGN_API_NODE.compile(context="")
+    logger.info(prompt)
+    prompt = REFINED_DESIGN_NODE.compile(context="")
+    logger.info(prompt)
+
+
+if __name__ == "__main__":
+    main()

metagpt/actions/project_management.py

@@ -15,7 +15,7 @@
 
 from metagpt.actions import ActionOutput
 from metagpt.actions.action import Action
-from metagpt.actions.project_management_an import PM_NODE
+from metagpt.actions.project_management_an import PM_NODE, REFINED_PM_NODE
 from metagpt.config import CONFIG
 from metagpt.const import (
     PACKAGE_REQUIREMENTS_FILENAME,
@@ -93,7 +93,7 @@ async def _run_new_tasks(self, context, schema=CONFIG.prompt_schema):
 
     async def _merge(self, system_design_doc, task_doc, schema=CONFIG.prompt_schema) -> Document:
         context = NEW_REQ_TEMPLATE.format(context=system_design_doc.content, old_tasks=task_doc.content)
-        node = await PM_NODE.fill(context, self.llm, schema)
+        node = await REFINED_PM_NODE.fill(context, self.llm, schema)
         task_doc.content = node.instruct_content.model_dump_json()
         return task_doc
 

metagpt/actions/project_management_an.py

@@ -35,13 +35,36 @@
     ],
 )
 
+REFINED_LOGIC_ANALYSIS = ActionNode(
+    key="Refined Logic Analysis",
+    expected_type=List[List[str]],
+    instruction="Review and refine the logic analysis by merging the Legacy Content and Incremental Content. "
+    "Provide a comprehensive list of files with classes/methods/functions to be implemented or modified incrementally. "
+    "Include dependency analysis, consider potential impacts on existing code, and document necessary imports.",
+    example=[
+        ["game.py", "Contains Game class and ... functions"],
+        ["main.py", "Contains main function, from game import Game"],
+        ["new_feature.py", "Introduces NewFeature class and related functions"],
+        ["utils.py", "Modifies existing utility functions to support incremental changes"],
+    ],
+)
+
 TASK_LIST = ActionNode(
     key="Task list",
     expected_type=List[str],
     instruction="Break down the tasks into a list of filenames, prioritized by dependency order.",
     example=["game.py", "main.py"],
 )
 
+REFINED_TASK_LIST = ActionNode(
+    key="Refined Task list",
+    expected_type=List[str],
+    instruction="Review and refine the combined task list after the merger of Legacy Content and Incremental Content, "
+    "and consistent with Refined File List. Ensure that tasks are organized in a logical and prioritized order, "
+    "considering dependencies for a streamlined and efficient development process. ",
+    example=["new_feature.py", "utils", "game.py", "main.py"],
+)
+
 FULL_API_SPEC = ActionNode(
     key="Full API spec",
     expected_type=str,
@@ -54,9 +77,19 @@
     key="Shared Knowledge",
     expected_type=str,
     instruction="Detail any shared knowledge, like common utility functions or configuration variables.",
-    example="'game.py' contains functions shared across the project.",
+    example="`game.py` contains functions shared across the project.",
 )
 
+REFINED_SHARED_KNOWLEDGE = ActionNode(
+    key="Refined Shared Knowledge",
+    expected_type=str,
+    instruction="Update and expand shared knowledge to reflect any new elements introduced. This includes common "
+    "utility functions, configuration variables for team collaboration. Retain content that is not related to "
+    "incremental development but important for consistency and clarity.",
+    example="`new_module.py` enhances shared utility functions for improved code reusability and collaboration.",
+)
+
+
 ANYTHING_UNCLEAR_PM = ActionNode(
     key="Anything UNCLEAR",
     expected_type=str,
@@ -74,13 +107,25 @@
     ANYTHING_UNCLEAR_PM,
 ]
 
+REFINED_NODES = [
+    REQUIRED_PYTHON_PACKAGES,
+    REQUIRED_OTHER_LANGUAGE_PACKAGES,
+    REFINED_LOGIC_ANALYSIS,
+    REFINED_TASK_LIST,
+    FULL_API_SPEC,
+    REFINED_SHARED_KNOWLEDGE,
+    ANYTHING_UNCLEAR_PM,
+]
 
 PM_NODE = ActionNode.from_children("PM_NODE", NODES)
+REFINED_PM_NODE = ActionNode.from_children("REFINED_PM_NODE", REFINED_NODES)
 
 
 def main():
     prompt = PM_NODE.compile(context="")
     logger.info(prompt)
+    prompt = REFINED_PM_NODE.compile(context="")
+    logger.info(prompt)
 
 
 if __name__ == "__main__":