xiaxinhang/pr-agent
1
0
Fork 0
mirror of https://github.com/qodo-ai/pr-agent.git synced 2025-07-03 04:10:49 +08:00
Code Issues Packages Projects Releases Wiki Activity

feat: Enhance PR description with file label dictionary and update prompts in pr_description_prompts.toml

Browse Source
This commit is contained in:
mrT23
2023-12-06 12:30:51 +02:00
parent f629755a9a
commit 4b073b32a5
2 changed files with 38 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
pr_agent/settings/pr_description_prompts.toml
View File

@ -37,9 +37,10 @@ class FileWalkthrough(BaseModel):
{%- endif %}
{%- if enable_semantic_files_types %}
class SemanticFileLabels(BaseModel):
label: str = Field(description="a semantic label that represents a type of code changes that occurred in the PR. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formating', 'miscellaneous', ...")
files: List[str] = Field(description="a list of file names related to the chosen semantic label. Present the file full path, and nothing else. A file should appear only in a single label, that best describes the type of changes in the file. If you are not sure, prefer a more general label.")
Class FileDescription(BaseModel):
filename: str = Field(description="the relevant file full path")
changes_summary: str = Field(description="minimal and concise description of the important changes in the relevant file")
label: str = Field(description="a single semantic label that represents a type of code changes that occurred in the File. Possible values (partial list): 'bug fix', 'tests', 'enhancement', 'documentation', 'error handling', 'configuration changes', 'dependencies', 'formating', 'miscellaneous', ...")
{%- endif %}
Class PRDescription(BaseModel):
@ -53,7 +54,7 @@ Class PRDescription(BaseModel):
main_files_walkthrough: List[FileWalkthrough] = Field(max_items=10)
{%- endif %}
{%- if enable_semantic_files_types %}
pr_files_labels[List[SemanticFileLabels]] = Field(min_items=2, description="A list of semantic labels that describe the type of changes in the PR files.")
pr_files[List[FileDescription]] = Field(max_items=15)
{%- endif %}
=====
@ -79,12 +80,12 @@ main_files_walkthrough:
- ...
{%- endif %}
{%- if enable_semantic_files_types %}
pr_files_labels:
- label: ...
files:
- |
pr_files:
- filename: |
...
- |
changes_summary: |
...
label: |
...
...
{%- endif %}

42
pr_agent/tools/pr_description.py
View File

@ -81,6 +81,19 @@ class PRDescription:
else:
return None
self.file_label_dict = {}
for file in self.data['pr_files']:
try:
filename = file['filename'].replace("'", "`").replace('"', '`')
changes_summary = file['changes_summary']
label = file['label']
if label not in self.file_label_dict:
self.file_label_dict[label] = []
self.file_label_dict[label].append((filename, changes_summary))
except Exception as e:
get_logger().error(f"Error preparing file label dict {self.pr_id}: {e}")
pass
pr_labels = []
if get_settings().pr_description.publish_labels:
pr_labels = self._prepare_labels()
@ -260,8 +273,8 @@ class PRDescription:
pr_body = ""
for idx, (key, value) in enumerate(self.data.items()):
key_publish = key.rstrip(':').replace("_", " ").capitalize()
if key == 'pr_files_labels':
key_publish = 'PR Changes Analysis'
if key == 'pr_files':
value = self.file_label_dict
pr_body += f"## {key_publish}\n"
if 'walkthrough' in key.lower():
# for filename, description in value.items():
@ -273,21 +286,21 @@ class PRDescription:
pr_body += f'- `{filename}`: {description}\n'
if self.git_provider.is_supported("gfm_markdown"):
pr_body +="</details>\n"
elif 'pr_files_labels' in key.lower():
elif 'pr_files' in key.lower():
pr_body += """\n| | Relevant Files """
pr_body += "&nbsp; " * 60
pr_body += "&nbsp; " * 70
pr_body += """|\n|-----------|-------------|\n"""
for semantic_label in value:
# for filename, description in value.items():
s_label = semantic_label['label'].strip("'").strip('"')
for semantic_label in value.keys():
s_label = semantic_label.strip("'").strip('"')
if self.git_provider.is_supported("gfm_markdown"):
# pr_body += f"<details> <summary>{semantic_label['label']}</summary>\n\n"
pr_body += f"| **{s_label}** | <details><summary>files:</summary><ul>"
else:
pr_body += f"| **{s_label}** | "
for file in semantic_label['files']:
filename = file.replace("'", "`")
list_tuples = value[semantic_label]
for filename,file_change_description in list_tuples:
filename = filename.replace("'", "`")
# description = file['changes_in_file']
# pr_body += f'- `{filename}`\n'
@ -298,13 +311,14 @@ class PRDescription:
if link:
filename = f"[{filename}]({link})"
if self.git_provider.is_supported("gfm_markdown"):
pr_body += f"<li>{filename}</li>"
else:
pr_body += f"{filename} &emsp; &emsp;"
pr_body += f"<details><summary>{filename}</summary>"
pr_body += f"<ul>Change summary:<br>**{file_change_description}**</ul></details>"
# else:
# pr_body += f"{filename} &emsp; &emsp;"
if self.git_provider.is_supported("gfm_markdown"):
pr_body += "</ul></details>|\n"
else:
pr_body += "|"
# else:
# pr_body += "|"
else:
# if the value is a list, join its items by comma
if isinstance(value, list):