feat: Dynamic File Editing #3063

Saedbhati · 2025-08-25T07:06:08Z

Description

Describe your changes in detail (optional if the linked issue already contains a detailed description of the changes).
Fixes #2981

Checklist

Go over all the following points, and put an x in all the boxes that apply.

I have read the CONTRIBUTION guide (required)
I have linked this PR to an issue using the Development section on the right sidebar or by adding Fixes #issue-number in the PR description (required)
I have checked if any dependencies need to be added or updated in pyproject.toml and uv lock
I have updated the tests accordingly (required for a bug fix or a new feature)
I have updated the documentation if needed:
I have added examples if this is a new feature

If you are unsure about any of these, don't hesitate to ask. We are here to help!

coderabbitai · 2025-08-25T07:06:14Z

Important

Review skipped

Auto reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment
Commit unit tests in branch dynamic_file_editing

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

Wendong-Fan

thanks @Saedbhati , left some comments below, we also need to add test code for new feature, one PR here for some quick enhancement: #3088

Wendong-Fan · 2025-08-30T17:55:00Z

camel/toolkits/file_write_toolkit.py

+        except ImportError:
+            return (
+                "Error reading YAML file: PyYAML package not installed. "
+                "Please install with: pip install PyYAML"
+            )


use decorator would be more tidy and unified: @dependencies_required('yaml'), same for other parts

Wendong-Fan · 2025-08-30T18:40:49Z

examples/toolkits/file_write_toolkit.py

I got error below when i run the example code, I think in previous tasks we didn't mention that the created python file should be named as simple_flask_server.py

2025-08-31 02:38:07,434 - camel.camel.agents.chat_agent - WARNING - Error executing tool 'read_file': Execution of function read_file failed with arguments () and {'file_path': 'simple_flask_server.py'}. Error: [Errno 2] No such file or directory: '/Users/enrei/Desktop/repos/camel0829/camel/file_write_outputs/simple_flask_server.py' with result: Tool execution failed: Error executing tool 'read_file': Execution of function read_file failed with arguments () and {'file_path': 'simple_flask_server.py'}. Error: [Errno 2] No such file or directory: '/Users/enrei/Desktop/repos/camel0829/camel/file_write_outputs/simple_flask_server.py'

Wendong-Fan · 2025-08-30T18:53:37Z

camel/toolkits/file_write_toolkit.py

@@ -1072,4 +1445,7 @@ def get_tools(self) -> List[FunctionTool]:
        """
        return [
            FunctionTool(self.write_to_file),
+            FunctionTool(self.read_file),
+            FunctionTool(self.edit_file),
+            FunctionTool(self.insert_at_line),


tried run this function, got

2025-08-31 02:52:04,460 - camel.camel.toolkits.file_write_toolkit - ERROR - Error inserting content in file /Users/enrei/Desktop/repos/camel0829/camel/examples/toolkits/mock_test_file.pdf: 'utf-8' codec can't decode byte 0x93 in position 10: invalid start byte

with test file: https://chatgpt.com/share/68b3489b-3ed4-8013-86e3-ad255bd018d9
and task: Please insert a new route '/contact' that returns 'Contact us at contact@example.com' to the /Users/enrei/Desktop/repos/camel0829/camel/examples/toolkits/mock_test_file.pdf file, you must use insert_at_line function

seems now we don't support binary files that can't be decoded as text?

Wendong-Fan · 2025-08-30T18:59:14Z

camel/toolkits/file_write_toolkit.py

+            logger.error(error_msg)
+            return error_msg
+
+    def insert_at_line(


the design of this function is confused

why we need insert_at_line as we already have edit_file , what case is this function designed for, we need to specify this in docstring for the agent to understand better

how could the agent know which line the content should insert? there's no function or design to provide the line number to the agent

Wendong-Fan · 2025-08-30T19:03:28Z

camel/toolkits/file_write_toolkit.py

+            if extension in [".doc", ".docx"]:
+                self._edit_docx_file(resolved_path, old_content, new_content)
+            elif extension == ".json":
+                self._edit_json_file(resolved_path, old_content, new_content)
+            elif extension in [".yaml", ".yml"]:
+                self._edit_yaml_file(resolved_path, old_content, new_content)
+            else:
+                # For text files, use simple text replacement
+                return self._perform_text_replacement(
+                    resolved_path, old_content, new_content


the supported file format is limited, at least we also need support types like .pdf as we supported in write_to_file

Wendong-Fan · 2025-08-30T19:06:24Z

camel/toolkits/file_write_toolkit.py

+        except ImportError as e:
+            raise ImportError(
+                "The python-docx package is required for DOCX file operations."
+                "Please install it with: pip install camel-ai[document_tools]"
+            ) from e


it's not necessary, we could require the dependency to remove unnecessary except case to make code more tidy, same for other parts

Wendong-Fan · 2025-08-30T19:07:02Z

camel/toolkits/file_write_toolkit.py

+        except ImportError:
+            try:
+                import pypdf
+
+                with open(file_path, 'rb') as file:
+                    pdf_reader = pypdf.PdfReader(file)  # type: ignore[assignment]
+                    text = ""
+                    for page in pdf_reader.pages:
+                        text += page.extract_text() + "\n"
+                    return text
+            except ImportError as e:


it's not necessary, we could require the dependency to remove unnecessary except case to make code more tidy, same for other parts

Wendong-Fan · 2025-08-30T19:07:44Z

camel/toolkits/file_write_toolkit.py

should we update the class naming and the description since now we not only support file write, but also file editing?

Wendong-Fan · 2025-08-30T19:10:44Z

camel/toolkits/file_write_toolkit.py

@@ -1072,4 +1445,7 @@ def get_tools(self) -> List[FunctionTool]:
        """
        return [
            FunctionTool(self.write_to_file),
+            FunctionTool(self.read_file),


for read_file , we can use loaders like markitdown which has better performance, maybe later support user config the BaseLoader (after #2819 merged) when they initialize FileWriteToolkit

waleedalzarooni

Hey @Saedbhati great integration!

I included some comments on function design that may be helpful to consider, otherwise awesome work!

waleedalzarooni · 2025-09-02T12:31:37Z

camel/toolkits/file_write_toolkit.py

+                # Simple string replacement
+                json_str = json.dumps(data, ensure_ascii=False)
+                if old_content in json_str:
+                    updated_str = json_str.replace(old_content, new_content)


Using str.replace() can cause some issues since we are altering json's

Replaces ALL occurrences of the search text, so {"message": "Hello", "user_message": "Hi"} becomes {"greeting": "Hello", "user_greeting": "Hi"} when searching for "message"

When str.replace() modifies JSON content, it can break the fundamental syntax rules. For example, if you accidentally replace a quote mark, bracket, or comma, the resulting string may no longer be valid JSON.

Replacing " with ' in{"name": "John"} creates {'name': 'John'} (invalid JSON - single quotes not allowed)

Replacing , with ; in {"a": 1, "b": 2} creates {"a": 1; "b": 2} (invalid JSON - semicolons not valid separators)

Replacing { with [ in {"data": {"nested": "value"}} creates ["data": {"nested": "value"}} (invalid JSON - mismatched brackets)

waleedalzarooni · 2025-09-02T13:05:43Z

camel/toolkits/file_write_toolkit.py

+            # Replace entire document content
+            for paragraph in doc.paragraphs[:]:
+                p = paragraph._element
+                p.getparent().remove(p)


p.getparent().remove(p) removes paragraph element from XML tree which will delete any font information, styling, alignment, indentation. This will result in new text additions being added with the default font settings, which may cause text replacements to look strange in the existing file

a7m-1st · 2025-09-04T10:53:18Z

@Saedbhati thanks for your PR, may I know what issues you are facing? In what conditions would you think that its ready for production.

Perhaps we can open an issue for contribution.

Saedbhati · 2025-09-04T13:32:18Z

@a7m-1st i think there are better approach than this like patching or using regex to replace text. Most AI code editor use Patching method

Wendong-Fan

test code need to be updated

Wendong-Fan · 2025-09-06T22:34:16Z

hey @Saedbhati @a7m-1st , I think adding optional regex/patch modes would make it more powerful for advanced scenarios, let's create another issue and PR for this

Wendong-Fan · 2025-09-06T23:06:02Z

thanks @Saedbhati , @a7m-1st @waleedalzarooni ! added enhance PR: #3109

enhance: Dynamic File Editing

316fb68

Saedbhati marked this pull request as draft August 25, 2025 10:15

Merge branch 'master' into dynamic_file_editing

15ddd06

Wendong-Fan marked this pull request as ready for review August 29, 2025 21:56

Merge branch 'master' into dynamic_file_editing

ef15573

Wendong-Fan requested review from a7m-1st and waleedalzarooni August 29, 2025 21:56

Wendong-Fan reviewed Aug 30, 2025

View reviewed changes

Wendong-Fan assigned Saedbhati Aug 30, 2025

Wendong-Fan added this to the Sprint 36 milestone Aug 30, 2025

Wendong-Fan added this to Project Camel Aug 30, 2025

Wendong-Fan added New Feature Waiting for Update PR has been reviewed, need to be updated based on review comment labels Aug 30, 2025

enhance: Dynamic File Editing PR3063 (#3088)

f60601c

waleedalzarooni reviewed Sep 2, 2025

View reviewed changes

Saedbhati and others added 2 commits September 3, 2025 13:39

Merge branch 'master' into dynamic_file_editing

1305087

pdf and refactor

4823933

Saedbhati requested a review from waleedalzarooni September 4, 2025 16:38

Saedbhati and others added 2 commits September 4, 2025 22:08

Merge branch 'master' into dynamic_file_editing

1564ac9

Merge branch 'master' into dynamic_file_editing

a9afdc1

Wendong-Fan reviewed Sep 6, 2025

View reviewed changes

Wendong-Fan closed this Sep 6, 2025

Wendong-Fan deleted the dynamic_file_editing branch September 6, 2025 22:31

Wendong-Fan restored the dynamic_file_editing branch September 6, 2025 22:31

Wendong-Fan reopened this Sep 6, 2025

Wendong-Fan changed the title ~~enhance: Dynamic File Editing~~ feat: Dynamic File Editing Sep 6, 2025

enhance: Dynamic File Editing PR3063 (#3109)

ee973b8

Wendong-Fan merged commit a4acd7c into master Sep 6, 2025
12 of 13 checks passed

Wendong-Fan deleted the dynamic_file_editing branch September 6, 2025 23:13

feat: Dynamic File Editing #3063

feat: Dynamic File Editing #3063

Conversation

Saedbhati commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Checklist

Uh oh!

coderabbitai bot commented Aug 25, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Uh oh!

Wendong-Fan left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

waleedalzarooni left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

a7m-1st commented Sep 4, 2025

Uh oh!

Saedbhati commented Sep 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Wendong-Fan left a comment

Choose a reason for hiding this comment

Uh oh!

Wendong-Fan commented Sep 6, 2025

Uh oh!

Wendong-Fan commented Sep 6, 2025

Uh oh!

Uh oh!

Uh oh!

Saedbhati commented Aug 25, 2025 •

edited

Loading

coderabbitai bot commented Aug 25, 2025 •

edited

Loading

Wendong-Fan left a comment •

edited

Loading

Saedbhati commented Sep 4, 2025 •

edited

Loading