Refactor the indent lines function to use tool_utils

This commit is contained in:
Amar Sood (tekacs) 2025-04-12 09:02:39 -04:00
parent c55d789c25
commit 7eac68e267

View file

@ -1,10 +1,20 @@
import os
import traceback
from .tool_utils import (
ToolError,
validate_file_for_edit,
find_pattern_indices,
select_occurrence_index,
determine_line_range,
apply_change,
handle_tool_error,
format_tool_result,
)
def _execute_indent_lines(coder, file_path, start_pattern, end_pattern=None, line_count=None, indent_levels=1, near_context=None, occurrence=1, change_id=None, dry_run=False):
"""
Indent or unindent a block of lines in a file.
Indent or unindent a block of lines in a file using utility functions.
Parameters:
- coder: The Coder instance
- file_path: Path to the file to modify
@ -16,119 +26,37 @@ def _execute_indent_lines(coder, file_path, start_pattern, end_pattern=None, lin
- occurrence: Which occurrence of the start_pattern to use (1-based index, or -1 for last)
- change_id: Optional ID for tracking the change
- dry_run: If True, simulate the change without modifying the file
Returns a result message.
"""
tool_name = "IndentLines"
try:
# Get absolute file path
abs_path = coder.abs_root_path(file_path)
rel_path = coder.get_rel_fname(abs_path)
# Check if file exists
if not os.path.isfile(abs_path):
coder.io.tool_error(f"File '{file_path}' not found")
return f"Error: File not found"
# Check if file is in editable context
if abs_path not in coder.abs_fnames:
if abs_path in coder.abs_read_only_fnames:
coder.io.tool_error(f"File '{file_path}' is read-only. Use MakeEditable first.")
return f"Error: File is read-only. Use MakeEditable first."
else:
coder.io.tool_error(f"File '{file_path}' not in context")
return f"Error: File not in context"
# Reread file content immediately before modification
file_content = coder.io.read_text(abs_path)
if file_content is None:
coder.io.tool_error(f"Could not read file '{file_path}' before IndentLines operation.")
return f"Error: Could not read file '{file_path}'"
# Validate we have either end_pattern or line_count, but not both
if end_pattern and line_count:
coder.io.tool_error("Cannot specify both end_pattern and line_count")
return "Error: Cannot specify both end_pattern and line_count"
# Split into lines for easier handling
lines = file_content.splitlines()
original_content = file_content
# Find occurrences of the start_pattern
start_pattern_line_indices = []
for i, line in enumerate(lines):
if start_pattern in line:
if near_context:
context_window_start = max(0, i - 5)
context_window_end = min(len(lines), i + 6)
context_block = "\n".join(lines[context_window_start:context_window_end])
if near_context in context_block:
start_pattern_line_indices.append(i)
else:
start_pattern_line_indices.append(i)
# 1. Validate file and get content
abs_path, rel_path, original_content = validate_file_for_edit(coder, file_path)
lines = original_content.splitlines()
if not start_pattern_line_indices:
err_msg = f"Start pattern '{start_pattern}' not found"
if near_context: err_msg += f" near context '{near_context}'"
err_msg += f" in file '{file_path}'."
coder.io.tool_error(err_msg)
return f"Error: {err_msg}"
# 2. Find the start line
pattern_desc = f"Start pattern '{start_pattern}'"
if near_context:
pattern_desc += f" near context '{near_context}'"
start_pattern_indices = find_pattern_indices(lines, start_pattern, near_context)
start_line_idx = select_occurrence_index(start_pattern_indices, occurrence, pattern_desc)
# Select the occurrence for the start pattern
num_occurrences = len(start_pattern_line_indices)
try:
occurrence = int(occurrence)
if occurrence == -1:
target_idx = num_occurrences - 1
elif occurrence > 0 and occurrence <= num_occurrences:
target_idx = occurrence - 1
else:
err_msg = f"Occurrence number {occurrence} is out of range for start pattern '{start_pattern}'. Found {num_occurrences} occurrences"
if near_context: err_msg += f" near '{near_context}'"
err_msg += f" in '{file_path}'."
coder.io.tool_error(err_msg)
return f"Error: {err_msg}"
except ValueError:
coder.io.tool_error(f"Invalid occurrence value: '{occurrence}'. Must be an integer.")
return f"Error: Invalid occurrence value '{occurrence}'"
# 3. Determine the end line
start_line, end_line = determine_line_range(
lines, start_line_idx, end_pattern, line_count, pattern_desc=pattern_desc
)
start_line = start_pattern_line_indices[target_idx]
occurrence_str = f"occurrence {occurrence} of " if num_occurrences > 1 else ""
# Find the end line based on end_pattern or line_count
end_line = -1
if end_pattern:
for i in range(start_line, len(lines)):
if end_pattern in lines[i]:
end_line = i
break
if end_line == -1:
err_msg = f"End pattern '{end_pattern}' not found after {occurrence_str}start pattern '{start_pattern}' (line {start_line + 1}) in '{file_path}'."
coder.io.tool_error(err_msg)
return f"Error: {err_msg}"
elif line_count:
try:
line_count = int(line_count)
if line_count <= 0: raise ValueError("Line count must be positive")
end_line = min(start_line + line_count - 1, len(lines) - 1)
except ValueError:
coder.io.tool_error(f"Invalid line_count value: '{line_count}'. Must be a positive integer.")
return f"Error: Invalid line_count value '{line_count}'"
else:
end_line = start_line
# Determine indentation amount
# 4. Validate and prepare indentation
try:
indent_levels = int(indent_levels)
except ValueError:
coder.io.tool_error(f"Invalid indent_levels value: '{indent_levels}'. Must be an integer.")
return f"Error: Invalid indent_levels value '{indent_levels}'"
raise ToolError(f"Invalid indent_levels value: '{indent_levels}'. Must be an integer.")
indent_str = ' ' * 4 # Assume 4 spaces per level
# Create a temporary copy to calculate the change
modified_lines = list(lines)
# Apply indentation to the temporary copy
# Apply indentation logic (core logic remains)
for i in range(start_line, end_line + 1):
if indent_levels > 0:
modified_lines[i] = (indent_str * indent_levels) + modified_lines[i]
@ -138,60 +66,58 @@ def _execute_indent_lines(coder, file_path, start_pattern, end_pattern=None, lin
actual_remove = min(spaces_to_remove, current_leading_spaces)
if actual_remove > 0:
modified_lines[i] = modified_lines[i][actual_remove:]
# Join lines back into a string
new_content = '\n'.join(modified_lines)
if original_content == new_content:
coder.io.tool_warning(f"No changes made: indentation would not change file")
return f"Warning: No changes made (indentation would not change file)"
# Generate diff for feedback (assuming _generate_diff_snippet_indent is available on coder)
# 5. Generate diff for feedback
diff_snippet = coder._generate_diff_snippet_indent(original_content, new_content, start_line, end_line)
# Handle dry run
if dry_run:
action = "indent" if indent_levels > 0 else "unindent"
coder.io.tool_output(f"Dry run: Would {action} lines {start_line+1}-{end_line+1} (based on {occurrence_str}start pattern '{start_pattern}') in {file_path}")
return f"Dry run: Would {action} block. Diff snippet:\n{diff_snippet}"
# --- Apply Change (Not dry run) ---
coder.io.write_text(abs_path, new_content)
# Track the change
try:
metadata = {
'start_line': start_line + 1,
'end_line': end_line + 1,
'start_pattern': start_pattern,
'end_pattern': end_pattern,
'line_count': line_count,
'indent_levels': indent_levels,
'near_context': near_context,
'occurrence': occurrence,
}
change_id = coder.change_tracker.track_change(
file_path=rel_path,
change_type='indentlines',
original_content=original_content,
new_content=new_content,
metadata=metadata,
change_id=change_id
)
except Exception as track_e:
coder.io.tool_error(f"Error tracking change for IndentLines: {track_e}")
change_id = "TRACKING_FAILED"
coder.aider_edited_files.add(rel_path)
# Improve feedback
action = "Indented" if indent_levels > 0 else "Unindented"
num_occurrences = len(start_pattern_indices)
occurrence_str = f"occurrence {occurrence} of " if num_occurrences > 1 else ""
action = "indent" if indent_levels > 0 else "unindent"
levels = abs(indent_levels)
level_text = "level" if levels == 1 else "levels"
num_lines = end_line - start_line + 1
# 6. Handle dry run
if dry_run:
dry_run_message = f"Dry run: Would {action} {num_lines} lines ({start_line+1}-{end_line+1}) by {levels} {level_text} (based on {occurrence_str}start pattern '{start_pattern}') in {file_path}."
return format_tool_result(coder, tool_name, "", dry_run=True, dry_run_message=dry_run_message, diff_snippet=diff_snippet)
# 7. Apply Change (Not dry run)
metadata = {
'start_line': start_line + 1,
'end_line': end_line + 1,
'start_pattern': start_pattern,
'end_pattern': end_pattern,
'line_count': line_count,
'indent_levels': indent_levels,
'near_context': near_context,
'occurrence': occurrence,
}
final_change_id = apply_change(
coder, abs_path, rel_path, original_content, new_content, 'indentlines', metadata, change_id
)
# 8. Format and return result
action_past = "Indented" if indent_levels > 0 else "Unindented"
success_message = f"{action_past} {num_lines} lines by {levels} {level_text} (from {occurrence_str}start pattern) in {file_path}"
return format_tool_result(
coder, tool_name, success_message, change_id=final_change_id, diff_snippet=diff_snippet
)
except ToolError as e:
# Handle errors raised by utility functions (expected errors)
return handle_tool_error(coder, tool_name, e, add_traceback=False)
except Exception as e:
# Handle unexpected errors
return handle_tool_error(coder, tool_name, e)
coder.io.tool_output(f"{action} {num_lines} lines (from {occurrence_str}start pattern) by {levels} {level_text} in {file_path} (change_id: {change_id})")
return f"Successfully {action.lower()} {num_lines} lines by {levels} {level_text} (change_id: {change_id}). Diff snippet:\n{diff_snippet}"
except Exception as e:
coder.io.tool_error(f"Error in IndentLines: {str(e)}\n{traceback.format_exc()}")
return f"Error: {str(e)}"
return f"Error: {str(e)}"