Upload 7 files

ParseFeedbackAtomicFlow.py

@@ -14,8 +14,22 @@ class ParseFeedbackAtomicFlow(AtomicFlow):
     *Output Interface*:
     - `code`: The content of the code file.
     - `feedback`: The feedback from the user.
+
+    *Configuration Parameters*:
+    - `input_interface`: The input interface of the flow.
+    - `output_interface`: The output interface of the flow.
+
     """
     def _read_content(self, file_location, file_type):
+        """
+        Read the content of the file and return the content of the file.
+        :param file_location: The location of the file.
+        :type file_location: str
+        :param file_type: The type of the file, should be either "code" or "plan".
+        :type file_type: str
+        :return: The content of the file.
+        :rtype: str
+        """
         if file_type == "code":
             header_string = "# Code:\n"
         elif file_type == "plan":
@@ -39,6 +53,13 @@ class ParseFeedbackAtomicFlow(AtomicFlow):
         return ret
 
     def _parse_user_thoughts(self, file_location):
+        """
+        Parse the user thoughts from the file.
+        :param file_location: The location of the file.
+        :type file_location: str
+        :return: The user thoughts.
+        :rtype: str
+        """
         with open(file_location, "r") as file:
             content = file.read()
 
@@ -61,6 +82,13 @@ class ParseFeedbackAtomicFlow(AtomicFlow):
         return thoughts
 
     def _check_input(self, input_data: Dict[str, Any]):
+        """
+        Check if the input is valid.
+        :param input_data: The input data.
+        :type input_data: Dict[str, Any]
+        :raises AssertionError: If neither code file nor plan file is passed to ParseFeedbackAtomicFlow.
+        :raises AssertionError: If both code file and plan file are passed to ParseFeedbackAtomicFlow.
+        """
         code_file_exists = "temp_code_file_location" in input_data
         plan_file_exists = "temp_plan_file_location" in input_data
         if code_file_exists == False and plan_file_exists == False:
@@ -69,6 +97,13 @@ class ParseFeedbackAtomicFlow(AtomicFlow):
             raise AssertionError("Both code file and plan file are passed to ParseFeedbackAtomic, which one to parse?")
 
     def _open_file_and_wait_for_file_update(self, file_location, check_interval=1):
+        """
+        Open the file in VSCode and wait for the user to close the file.
+        :param file_location: The location of the file.
+        :type file_location: str
+        :param check_interval: The interval between two checks, defaults to 1.
+        :type check_interval: int, optional
+        """
         process = subprocess.Popen(["code", "--wait", file_location])
         while True:
             if process.poll() is not None:
@@ -79,6 +114,13 @@ class ParseFeedbackAtomicFlow(AtomicFlow):
             self,
             input_data: Dict[str, Any]
     ):
+        """
+        Run the flow.
+        :param input_data: The input data.
+        :type input_data: Dict[str, Any]
+        :return: The output data.
+        :rtype: Dict[str, Any]
+        """
         response = {}
         self._check_input(input_data)
         if "temp_code_file_location" in input_data:

README.md

@@ -2,6 +2,9 @@
 
 * [ParseFeedbackAtomicFlow](#ParseFeedbackAtomicFlow)
   * [ParseFeedbackAtomicFlow](#ParseFeedbackAtomicFlow.ParseFeedbackAtomicFlow)
+    * [run](#ParseFeedbackAtomicFlow.ParseFeedbackAtomicFlow.run)
+* [example\_code\_file](#example_code_file)
+* [run](#run)
 * [\_\_init\_\_](#__init__)
 
 <a id="ParseFeedbackAtomicFlow"></a>
@@ -23,9 +26,39 @@ The flow will open the file in VSCode and wait for the user to edit the file. On
 - `temp_code_file_location`: Notice that if we are parsing the plan file, this should be changed to `temp_plan_file_location`.
 
 *Output Interface*:
-- `code`: The content of the code file. In case that we are parsing the plan file, the output is then `plan`
+- `code`: The content of the code file.
 - `feedback`: The feedback from the user.
 
+*Configuration Parameters*:
+- `input_interface`: The input interface of the flow.
+- `output_interface`: The output interface of the flow.
+
+<a id="ParseFeedbackAtomicFlow.ParseFeedbackAtomicFlow.run"></a>
+
+#### run
+
+```python
+def run(input_data: Dict[str, Any])
+```
+
+Run the flow.
+
+**Arguments**:
+
+- `input_data` (`Dict[str, Any]`): The input data.
+
+**Returns**:
+
+`Dict[str, Any]`: The output data.
+
+<a id="example_code_file"></a>
+
+# example\_code\_file
+
+<a id="run"></a>
+
+# run
+
 <a id="__init__"></a>
 
 # \_\_init\_\_