github/OpenHands
1
0
Fork 0
mirror of https://github.com/OpenHands/OpenHands.git synced 2025-12-26 05:48:36 +08:00
Code Issues Packages Projects Releases Wiki Activity

file_ops: Use tmp file for original linting (#3681)

Browse Source 
Fix a potential issue that might lead to file corruption when edit linting is enabled

#3124 introduces a feature for editing: running linter twice before and after the change and only extract new errors introduced by the agent. This has some potential issues and I am working on #3649 to address them, but I feel like I am not gonna finish it in the next few days, and that PR has become harder and harder to review, thus this PR, which only focuses on a small improvement.

So what's the issue? When we run linters on the original file before our edits, we need to copy the original file and use a temporary file to lint, because linting may have side-effect (e.g. modifying the file in-place). I used the word "may" because:

Flake8 has no side-effect, so not a problem as of now.
We don't enforce this or document this "no side-effect" as a requirement for linter implementation, so side-effect is allowed.
Regardless, the "after-edit-linting" uses the same approach: backup the file before linting to avoid data corruption. We should keep our "before-edit-linting" consistent.

Why no new unittest that reproduces the issue? Well, as I have mentioned earlier, flake8 has no side-effect, so technically it's not a bug but a flaw. Therefore, there's no way to write a test that reproduces the issue.
This commit is contained in:
Boxuan Li 2024-09-01 23:36:57 -07:00 committed by GitHub
parent 7068a73ae7
commit 75d5591816
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
openhands/runtime/plugins/agent_skills/file_ops/file_ops.py
View File

@ -465,7 +465,11 @@ def _edit_file_impl(
# lint the original file
enable_auto_lint = os.getenv('ENABLE_AUTO_LINT', 'false').lower() == 'true'
if enable_auto_lint:
original_lint_error, _ = _lint_file(file_name)
# Copy the original file to a temporary file (with the same ext) and lint it
suffix = os.path.splitext(file_name)[1]
with tempfile.NamedTemporaryFile(suffix=suffix) as orig_file_clone:
shutil.copy2(file_name, orig_file_clone.name)
original_lint_error, _ = _lint_file(orig_file_clone.name)
# Create a temporary file
with tempfile.NamedTemporaryFile('w', delete=False) as temp_file: