Update CodeFileEditAtomicFlow.py

CodeFileEditAtomicFlow.py

@@ -19,6 +19,11 @@ class CodeFileEditAtomicFlow(AtomicFlow):
     - `temp_code_file_location`: str
     """
     def _generate_content(self, code_lib_location, code_str) -> str:
+        """This function generates the content to be written to the temp file.
+        :param code_lib_location (str): The location of the code library file.
+        :param code_str (str): The code to be written to the temp file.
+        :return: (str) The content to be written to the temp file.
+        """
         content = (
                 "# The below code will be appended to " +
                 code_lib_location + "\n"
@@ -33,11 +38,22 @@ class CodeFileEditAtomicFlow(AtomicFlow):
         return content
 
     def _generate_temp_file_location(self, code_lib_location):
+        """This function generates the location of the temp file.
+        :param code_lib_location (str): The location of the code library file.
+        :return: (str) The location of the temp file.
+        """
         directory = os.path.dirname(code_lib_location)
         ret = os.path.join(directory, 'temp.py')
         return ret
 
     def _write_code_content_to_file(self, file_location, content: str):
+        """This function writes the content to the temp file.
+        :param file_location (str): The location of the temp file.
+        :param content (str): The content to be written to the temp file.
+        :return: (bool, str, str) The first value is a boolean indicating if the write was successful.
+        The second value is a string containing the output of the write operation.
+        The third value is a string containing the location of the temp file.
+        """
         try:
             with open(file_location, "w") as file:
                 file.write(content)
@@ -48,6 +64,10 @@ class CodeFileEditAtomicFlow(AtomicFlow):
             return False, str(e), file_location
 
     def _check_input(self, input_data: Dict[str, Any]):
+        """This function checks if the input data is valid.
+        :param input_data (Dict[str, Any]): The input data.
+        :return: None
+        """
         assert "code" in input_data, "code is not passed to CodeFileEditAtomicFlow"
         assert "language_of_code" in input_data, "language_of_code is not passed to CodeFileEditAtomicFlow"
         assert "memory_files" in input_data, "memory_files is not passed to CodeFileEditAtomicFlow"
@@ -59,6 +79,11 @@ class CodeFileEditAtomicFlow(AtomicFlow):
         assert language_of_code.lower() == 'python', "sorry!! only writing python code is supported."
 
     def _generate_input_to_writer(self, input_data: Dict[str, Any]):
+        """This function generates the input to the writer function.
+        :param input_data (Dict[str, Any]): The input data.
+        :return: (str, str) The first value is a string containing the content to be written to the temp file.
+        The second value is a string containing the location of the temp file.
+        """
         code_str = input_data['code']
         code_lib_location = input_data["memory_files"]["code_library"]
         content_to_write = self._generate_content(code_lib_location, code_str)
@@ -69,6 +94,10 @@ class CodeFileEditAtomicFlow(AtomicFlow):
             self,
             input_data: Dict[str, Any]
     ):
+        """This function runs the atomic flow.
+        :param input_data (Dict[str, Any]): The input data.
+        :return: Dict[str, Any] The output data.
+        """
         self._check_input(input_data)
 
         # ~~~ Getting input data to the file editor ~~~