Add missing newline in extended patch and remove trailing whitespace

[mrT23]

PR Type

Enhancement

---

Description

• Added a missing newline before the extended patch header in git_patch_processing.py to improve readability and consistency of the patch format.
• Removed trailing whitespace from the extended patch in pr_processing.py using the rstrip() method to clean up the output.
• These changes enhance the overall formatting and presentation of patches in the PR agent.

---

Changes walkthrough 📝

	Relevant files
Enhancement	git_patch_processing.py Improve patch formatting in git_patch_processing                  pr_agent/algo/git_patch_processing.py Added a new line before the extended patch header +1/-0
Formatting	pr_processing.py Clean up patch formatting in pr_processing                              pr_agent/algo/pr_processing.py Removed trailing whitespace from the extended patch +1/-1

---

💡 PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-pro]

PR Reviewer Guide 🔍

⏱️ Estimated effort to review: 1 🔵⚪⚪⚪⚪

🏅 Score: 95

🧪 No relevant tests

🔒 No security concerns identified

🔀 No multiple PR themes

⚡ No key issues to review

[codiumai-pr-agent-pro]

PR Code Suggestions ✨

Category	Suggestion	Score
Best practice	Use an f-string for the entire string assignment Consider using an f-string for the entire full_extended_patch assignment to improve readability and consistency. pr_agent/algo/pr_processing.py [198] +full_extended_patch = f"\n\n## {file.filename}\n{extended_patch.rstrip()}\n" - Apply this suggestion Suggestion importance[1-10]: 7 Why: The suggestion improves code consistency and readability by using an f-string for the entire assignment, which is a best practice in Python.	7
Maintainability	Add a comment to explain the purpose of appending an empty string Consider adding a comment to explain the purpose of appending an empty string to extended_patch_lines. This will improve code readability and maintainability. pr_agent/algo/git_patch_processing.py [73] +# Add an empty line to separate the hunk header from the content extended_patch_lines.append('') Apply this suggestion Suggestion importance[1-10]: 6 Why: The suggestion improves code readability by explaining the purpose of an empty string append, which is not immediately obvious from the code alone.	6
	Separate the string manipulation from the f-string assignment Consider moving the rstrip() call to a separate line before the f-string assignment for better readability and to separate concerns. pr_agent/algo/pr_processing.py [198] -full_extended_patch = f"\n\n## {file.filename}\n{extended_patch.rstrip()}\n" +extended_patch = extended_patch.rstrip() +full_extended_patch = f"\n\n## {file.filename}\n{extended_patch}\n" Apply this suggestion Suggestion importance[1-10]: 5 Why: While the suggestion could improve readability slightly, it introduces an additional line of code without significant benefits in this context.	5

[codiumai-pr-agent-pro]

CI Failure Feedback 🧐

(Checks updated until commit 4c1c313)

Action: build-and-test

Failed stage: Test dev docker [❌]

Failed test name: TestExtendPatch::test_happy_path

Failure summary: The action failed due to multiple test failures in the test_extend_patch.py file: TestExtendPatch::test_happy_path failed due to an incorrect patch output. TestExtendPatch::test_single_hunk failed for all tested line numbers. TestExtendPatch::test_multiple_hunks failed due to mismatched patch output. TestExtendedPatchMoreLines::test_extend_patches_with_extra_lines also failed. These failures suggest issues with the extend_patch function, particularly in handling different patch scenarios and line extensions.

Relevant error logs: 1: ##[group]Operating System 2: Ubuntu ... 1056: tests/unittest/test_convert_to_markdown.py::TestBR::test_br2 PASSED [ 28%] 1057: tests/unittest/test_convert_to_markdown.py::TestBR::test_br3 PASSED [ 29%] 1058: tests/unittest/test_delete_hunks.py::TestOmitDeletionHunks::test_simple_patch_additions PASSED [ 30%] 1059: tests/unittest/test_delete_hunks.py::TestOmitDeletionHunks::test_patch_multiple_hunks PASSED [ 32%] 1060: tests/unittest/test_delete_hunks.py::TestOmitDeletionHunks::test_patch_only_deletions PASSED [ 33%] 1061: tests/unittest/test_delete_hunks.py::TestOmitDeletionHunks::test_empty_patch PASSED [ 34%] 1062: tests/unittest/test_delete_hunks.py::TestOmitDeletionHunks::test_patch_one_hunk PASSED [ 35%] 1063: tests/unittest/test_delete_hunks.py::TestOmitDeletionHunks::test_patch_deletions_no_additions PASSED [ 37%] 1064: tests/unittest/test_extend_patch.py::TestExtendPatch::test_happy_path FAILED [ 38%] 1065: tests/unittest/test_extend_patch.py::TestExtendPatch::test_empty_patch PASSED [ 39%] 1066: tests/unittest/test_extend_patch.py::TestExtendPatch::test_zero_num_lines PASSED [ 41%] 1067: tests/unittest/test_extend_patch.py::TestExtendPatch::test_no_hunks PASSED [ 42%] 1068: tests/unittest/test_extend_patch.py::TestExtendPatch::test_single_hunk FAILED [ 43%] 1069: tests/unittest/test_extend_patch.py::TestExtendPatch::test_multiple_hunks FAILED [ 44%] 1070: tests/unittest/test_extend_patch.py::TestExtendedPatchMoreLines::test_extend_patches_with_extra_lines FAILED [ 46%] ... 1080: tests/unittest/test_find_line_number_of_relevant_line_in_file.py::TestFindLineNumberOfRelevantLineInFile::test_relevant_line_found_but_deleted PASSED [ 58%] 1081: tests/unittest/test_fix_output.py::TestTryFixJson::test_incomplete_code_suggestions PASSED [ 60%] 1082: tests/unittest/test_fix_output.py::TestTryFixJson::test_incomplete_code_suggestions_new_line PASSED [ 61%] 1083: tests/unittest/test_fix_output.py::TestTryFixJson::test_incomplete_code_suggestions_many_close_brackets PASSED [ 62%] 1084: tests/unittest/test_fix_output.py::TestTryFixJson::test_incomplete_code_suggestions_relevant_file PASSED [ 64%] 1085: tests/unittest/test_github_action_output.py::TestGitHubOutput::test_github_action_output_enabled PASSED [ 65%] 1086: tests/unittest/test_github_action_output.py::TestGitHubOutput::test_github_action_output_disabled PASSED [ 66%] 1087: tests/unittest/test_github_action_output.py::TestGitHubOutput::test_github_action_output_notset PASSED [ 67%] 1088: tests/unittest/test_github_action_output.py::TestGitHubOutput::test_github_action_output_error_case PASSED [ 69%] ... 1105: tests/unittest/test_parse_code_suggestion.py::TestParseCodeSuggestion::test_with_code_example_key PASSED [ 91%] 1106: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_valid_yaml PASSED [ 92%] 1107: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_add_relevant_line PASSED [ 93%] 1108: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_extract_snippet PASSED [ 94%] 1109: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_remove_last_line PASSED [ 96%] 1110: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_empty_yaml_fixed PASSED [ 97%] 1111: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_no_initial_yaml PASSED [ 98%] 1112: tests/unittest/test_try_fix_yaml.py::TestTryFixYaml::test_with_initial_yaml PASSED [100%] 1113: =================================== FAILURES =================================== ... 1116: def test_happy_path(self): 1117: original_file_str = 'line1\nline2\nline3\nline4\nline5' 1118: patch_str = '@@ -2,2 +2,2 @@ init()\n-line2\n+new_line2\n line3' 1119: num_lines = 1 1120: expected_output = '@@ -1,4 +1,4 @@ init()\n line1\n-line2\n+new_line2\n line3\n line4' 1121: actual_output = extend_patch(original_file_str, patch_str, 1122: patch_extra_lines_before=num_lines, patch_extra_lines_after=num_lines) 1123: > assert actual_output == expected_output 1124: E AssertionError: assert '\n@@ -1,4 +1...line3\n line4' == '@@ -1,4 +1,4...line3\n line4' 1125: E + 1126: E @@ -1,4 +1,4 @@ init() 1127: E line1 1128: E -line2 1129: E +new_line2 1130: E line3 1131: E line4 1132: tests/unittest/test_extend_patch.py:16: AssertionError ... 1135: def test_single_hunk(self): 1136: original_file_str = 'line1\nline2\nline3\nline4\nline5' 1137: patch_str = '@@ -2,3 +2,3 @@ init()\n-line2\n+new_line2\n line3\n line4' 1138: for num_lines in [1, 2, 3]: # check that even if we are over the number of lines in the file, the function still works 1139: expected_output = '@@ -1,5 +1,5 @@ init()\n line1\n-line2\n+new_line2\n line3\n line4\n line5' 1140: actual_output = extend_patch(original_file_str, patch_str, 1141: patch_extra_lines_before=num_lines, patch_extra_lines_after=num_lines) 1142: > assert actual_output == expected_output 1143: E AssertionError: assert '\n@@ -1,5 +1...line4\n line5' == '@@ -1,5 +1,5...line4\n line5' 1144: E + 1145: E @@ -1,5 +1,5 @@ init() 1146: E line1 1147: E -line2 1148: E +new_line2 1149: E line3 1150: E line4 1151: E line5 1152: tests/unittest/test_extend_patch.py:52: AssertionError ... 1155: def test_multiple_hunks(self): 1156: original_file_str = 'line1\nline2\nline3\nline4\nline5\nline6' 1157: patch_str = '@@ -2,3 +2,3 @@ init()\n-line2\n+new_line2\n line3\n line4\n@@ -4,1 +4,1 @@ init2()\n-line4\n+new_line4' # noqa: E501 1158: num_lines = 1 1159: expected_output = '@@ -1,5 +1,5 @@ init()\n line1\n-line2\n+new_line2\n line3\n line4\n line5\n@@ -3,3 +3,3 @@ init2()\n line3\n-line4\n+new_line4\n line5' # noqa: E501 1160: actual_output = extend_patch(original_file_str, patch_str, 1161: patch_extra_lines_before=num_lines, patch_extra_lines_after=num_lines) 1162: > assert actual_output == expected_output 1163: E AssertionError: assert '\n@@ -1,5 +1...line4\n line5' == '@@ -1,5 +1,5...line4\n line5' ... 1165: E @@ -1,5 +1,5 @@ init() 1166: E line1 1167: E -line2 1168: E +new_line2 1169: E line3 1170: E line4... 1171: E 1172: E ...Full output truncated (7 lines hidden), use '-vv' to show 1173: tests/unittest/test_extend_patch.py:62: AssertionError ... 1180: pr_languages, token_handler, add_line_numbers_to_hunks=False, 1181: patch_extra_lines_before=0, 1182: patch_extra_lines_after=0 1183: ) 1184: # Check that with no extra lines, the patches are the same as the original patches 1185: p0 = patches_extended_no_extra_lines[0].strip() 1186: p1 = patches_extended_no_extra_lines[1].strip() 1187: > assert p0 == '## file1\n\n' + pr_languages[0]['files'][0].patch.strip() 1188: E AssertionError: assert '## file1\n@@...line4\n line5' == '## file1\n\n...line4\n line5' ... 1190: E - 1191: E @@ -5,5 +5,5 @@ 1192: E -original content 1193: E +modified content 1194: E line2 1195: E line3 1196: E line4 1197: E line5 1198: tests/unittest/test_extend_patch.py:105: AssertionError ... 1222: /usr/local/lib/python3.12/site-packages/azure/devops/__init__.py:6: DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('azure.devops')`. 1223: Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages 1224: pkg_resources.declare_namespace(__name__) 1225: ../usr/local/lib/python3.12/site-packages/pkg_resources/__init__.py:2317 1226: /usr/local/lib/python3.12/site-packages/pkg_resources/__init__.py:2317: DeprecationWarning: Deprecated call to `pkg_resources.declare_namespace('azure')`. 1227: Implementing implicit namespace packages (as specified in PEP 420) is preferred to `pkg_resources.declare_namespace`. See https://setuptools.pypa.io/en/latest/references/keywords.html#keyword-namespace-packages 1228: declare_namespace(parent) 1229: ../usr/local/lib/python3.12/site-packages/pydantic/_internal/_config.py:291 1230: /usr/local/lib/python3.12/site-packages/pydantic/_internal/_config.py:291: PydanticDeprecatedSince20: Support for class-based `config` is deprecated, use ConfigDict instead. Deprecated in Pydantic V2.0 to be removed in V3.0. See Pydantic V2 Migration Guide at https://errors.pydantic.dev/2.8/migration/ ... 1235: tests/unittest/test_file_filter.py:44 1236: /app/tests/unittest/test_file_filter.py:44: SyntaxWarning: invalid escape sequence '\.' 1237: monkeypatch.setattr(global_settings.ignore, 'regex', ['^file[2-4]\..*$']) 1238: tests/unittest/test_file_filter.py:65 1239: /app/tests/unittest/test_file_filter.py:65: SyntaxWarning: invalid escape sequence '\.' 1240: monkeypatch.setattr(global_settings.ignore, 'regex', ['(((||', '^file[2-4]\..*$']) 1241: -- Docs: https://docs.pytest.org/en/stable/how-to/capture-warnings.html 1242: =========================== short test summary info ============================ 1243: FAILED tests/unittest/test_extend_patch.py::TestExtendPatch::test_happy_path 1244: FAILED tests/unittest/test_extend_patch.py::TestExtendPatch::test_single_hunk 1245: FAILED tests/unittest/test_extend_patch.py::TestExtendPatch::test_multiple_hunks 1246: FAILED tests/unittest/test_extend_patch.py::TestExtendedPatchMoreLines::test_extend_patches_with_extra_lines 1247: ================== 4 failed, 74 passed, 13 warnings in 3.22s =================== 1248: ##[error]Process completed with exit code 1.

---

✨ CI feedback usage guide:

---

The CI feedback tool (/checks) automatically triggers when a PR has a failed check.
The tool analyzes the failed checks and provides several feedbacks:

• Failed stage
• Failed test name
• Failure summary
• Relevant error logs

In addition to being automatically triggered, the tool can also be invoked manually by commenting on a PR:

/checks "https://github.com/{repo_name}/actions/runs/{run_number}/job/{job_number}"

where {repo_name} is the name of the repository, {run_number} is the run number of the failed check, and {job_number} is the job number of the failed check.

Configuration options

• enable_auto_checks_feedback - if set to true, the tool will automatically provide feedback when a check is failed. Default is true.
• excluded_checks_list - a list of checks to exclude from the feedback, for example: ["check1", "check2"]. Default is an empty list.
• enable_help_text - if set to true, the tool will provide a help message with the feedback. Default is true.
• persistent_comment - if set to true, the tool will overwrite a previous checks comment with the new feedback. Default is true.
• final_update_message - if persistent_comment is true and updating a previous checks message, the tool will also create a new message: "Persistent checks updated to latest commit". Default is true.

See more information about the checks tool in the docs.