Method replace_file_contents

ms_agent/tools/filesystem_tool.py:479–552

Replace exact content in a file without using line numbers. This method is safer for parallel operations as it doesn't rely on line numbers that might change when multiple agents modify the same file concurrently. Args: path(str): The relative file path to modif

(self,
                                    path: str,
                                    source: str = None,
                                    target: str = None,
                                    occurrence: int = 1)

            return f'Write file <{path}> failed, error: ' + str(e)

    async def replace_file_contents(self,
                                    path: str,
                                    source: str = None,
                                    target: str = None,
                                    occurrence: int = 1):
        """Replace exact content in a file without using line numbers.

        This method is safer for parallel operations as it doesn&#x27;t rely on line numbers
        that might change when multiple agents modify the same file concurrently.

        Args:
            path(str): The relative file path to modify
            source(str): The exact content to find and replace (must match exactly including whitespace)
            target(str): The new content to replace with
            occurrence(int): Which occurrence to replace (1-based). Use -1 to replace all occurrences.
                           Default is 1 (first occurrence).

        Returns:
            Success or error message.
        """
        try:
            if not source:
                return f'Error: You MUST provide the `source` parameter to be replaced with the `target`, but got {source}.'
            if target is None:
                return f'Error: You MUST provide the `target` parameter to replace the `source`, but got {target}.'
            target_path_real = self.get_real_path(path)
            if target_path_real is None:
                return f'<{path}> is out of the valid project path: {self.output_dir}'

            # Read file content
            if not os.path.exists(target_path_real):
                return f'Error: File <{path}> does not exist'

            with open(target_path_real, 'r', encoding='utf-8') as f:
                file_content = f.read()

            # Check if source exists
            if source not in file_content:
                return (
                    f'Error: Could not find the exact content to replace in <{path}>. '
                    f'Make sure the content matches exactly including all whitespace.'
                )

            # Count occurrences
            count = file_content.count(source)

            # Replace based on occurrence parameter
            if occurrence == -1:
                # Replace all occurrences
                updated_content = file_content.replace(source, target)
                operation_msg = f'Replaced all {count} occurrence(s)'
            elif occurrence < 1:
                return f'Error: occurrence must be >= 1 or -1 (for all), got {occurrence}'
            elif occurrence > count:
                return f'Error: occurrence {occurrence} exceeds total occurrences ({count}) of the content'
            else:
                # Replace specific occurrence
                parts = file_content.split(source, occurrence)