mirror of
https://github.com/qodo-ai/pr-agent.git
synced 2025-07-02 11:50:37 +08:00
257 lines
10 KiB
Python
257 lines
10 KiB
Python
import copy
|
|
import re
|
|
from typing import List, Tuple
|
|
|
|
from jinja2 import Environment, StrictUndefined
|
|
|
|
from pr_agent.algo.ai_handler import AiHandler
|
|
from pr_agent.algo.pr_processing import get_pr_diff, retry_with_fallback_models
|
|
from pr_agent.algo.token_handler import TokenHandler
|
|
from pr_agent.algo.utils import load_yaml
|
|
from pr_agent.config_loader import get_settings
|
|
from pr_agent.git_providers import get_git_provider
|
|
from pr_agent.git_providers.git_provider import get_main_pr_language
|
|
from pr_agent.log import get_logger
|
|
|
|
|
|
class PRDescription:
|
|
def __init__(self, pr_url: str, args: list = None):
|
|
"""
|
|
Initialize the PRDescription object with the necessary attributes and objects for generating a PR description
|
|
using an AI model.
|
|
Args:
|
|
pr_url (str): The URL of the pull request.
|
|
args (list, optional): List of arguments passed to the PRDescription class. Defaults to None.
|
|
"""
|
|
# Initialize the git provider and main PR language
|
|
self.git_provider = get_git_provider()(pr_url)
|
|
self.main_pr_language = get_main_pr_language(
|
|
self.git_provider.get_languages(), self.git_provider.get_files()
|
|
)
|
|
self.pr_id = self.git_provider.get_pr_id()
|
|
|
|
# Initialize the AI handler
|
|
self.ai_handler = AiHandler()
|
|
|
|
# Initialize the variables dictionary
|
|
self.vars = {
|
|
"title": self.git_provider.pr.title,
|
|
"branch": self.git_provider.get_pr_branch(),
|
|
"description": self.git_provider.get_pr_description(full=False),
|
|
"language": self.main_pr_language,
|
|
"diff": "", # empty diff for initial calculation
|
|
"use_bullet_points": get_settings().pr_description.use_bullet_points,
|
|
"extra_instructions": get_settings().pr_description.extra_instructions,
|
|
"commit_messages_str": self.git_provider.get_commit_messages()
|
|
}
|
|
|
|
self.user_description = self.git_provider.get_user_description()
|
|
|
|
# Initialize the token handler
|
|
self.token_handler = TokenHandler(
|
|
self.git_provider.pr,
|
|
self.vars,
|
|
get_settings().pr_description_prompt.system,
|
|
get_settings().pr_description_prompt.user,
|
|
)
|
|
|
|
# Initialize patches_diff and prediction attributes
|
|
self.patches_diff = None
|
|
self.prediction = None
|
|
|
|
async def run(self):
|
|
"""
|
|
Generates a PR description using an AI model and publishes it to the PR.
|
|
"""
|
|
|
|
try:
|
|
get_logger().info(f"Generating a PR description {self.pr_id}")
|
|
if get_settings().config.publish_output:
|
|
self.git_provider.publish_comment("Preparing PR description...", is_temporary=True)
|
|
|
|
await retry_with_fallback_models(self._prepare_prediction)
|
|
|
|
get_logger().info(f"Preparing answer {self.pr_id}")
|
|
if self.prediction:
|
|
self._prepare_data()
|
|
else:
|
|
return None
|
|
|
|
pr_labels = []
|
|
if get_settings().pr_description.publish_labels:
|
|
pr_labels = self._prepare_labels()
|
|
|
|
if get_settings().pr_description.use_description_markers:
|
|
pr_title, pr_body = self._prepare_pr_answer_with_markers()
|
|
else:
|
|
pr_title, pr_body, = self._prepare_pr_answer()
|
|
full_markdown_description = f"## Title\n\n{pr_title}\n\n___\n{pr_body}"
|
|
|
|
if get_settings().config.publish_output:
|
|
get_logger().info(f"Pushing answer {self.pr_id}")
|
|
if get_settings().pr_description.publish_description_as_comment:
|
|
self.git_provider.publish_comment(full_markdown_description)
|
|
else:
|
|
self.git_provider.publish_description(pr_title, pr_body)
|
|
if get_settings().pr_description.publish_labels and self.git_provider.is_supported("get_labels"):
|
|
current_labels = self.git_provider.get_labels()
|
|
if current_labels is None:
|
|
current_labels = []
|
|
self.git_provider.publish_labels(pr_labels + current_labels)
|
|
self.git_provider.remove_initial_comment()
|
|
except Exception as e:
|
|
get_logger().error(f"Error generating PR description {self.pr_id}: {e}")
|
|
|
|
return ""
|
|
|
|
async def _prepare_prediction(self, model: str) -> None:
|
|
"""
|
|
Prepare the AI prediction for the PR description based on the provided model.
|
|
|
|
Args:
|
|
model (str): The name of the model to be used for generating the prediction.
|
|
|
|
Returns:
|
|
None
|
|
|
|
Raises:
|
|
Any exceptions raised by the 'get_pr_diff' and '_get_prediction' functions.
|
|
|
|
"""
|
|
if get_settings().pr_description.use_description_markers and 'pr_agent:' not in self.user_description:
|
|
return None
|
|
|
|
get_logger().info(f"Getting PR diff {self.pr_id}")
|
|
self.patches_diff = get_pr_diff(self.git_provider, self.token_handler, model)
|
|
get_logger().info(f"Getting AI prediction {self.pr_id}")
|
|
self.prediction = await self._get_prediction(model)
|
|
|
|
async def _get_prediction(self, model: str) -> str:
|
|
"""
|
|
Generate an AI prediction for the PR description based on the provided model.
|
|
|
|
Args:
|
|
model (str): The name of the model to be used for generating the prediction.
|
|
|
|
Returns:
|
|
str: The generated AI prediction.
|
|
"""
|
|
variables = copy.deepcopy(self.vars)
|
|
variables["diff"] = self.patches_diff # update diff
|
|
|
|
environment = Environment(undefined=StrictUndefined)
|
|
system_prompt = environment.from_string(get_settings().pr_description_prompt.system).render(variables)
|
|
user_prompt = environment.from_string(get_settings().pr_description_prompt.user).render(variables)
|
|
|
|
if get_settings().config.verbosity_level >= 2:
|
|
get_logger().info(f"\nSystem prompt:\n{system_prompt}")
|
|
get_logger().info(f"\nUser prompt:\n{user_prompt}")
|
|
|
|
response, finish_reason = await self.ai_handler.chat_completion(
|
|
model=model,
|
|
temperature=0.2,
|
|
system=system_prompt,
|
|
user=user_prompt
|
|
)
|
|
|
|
return response
|
|
|
|
|
|
def _prepare_data(self):
|
|
# Load the AI prediction data into a dictionary
|
|
self.data = load_yaml(self.prediction.strip())
|
|
|
|
if get_settings().pr_description.add_original_user_description and self.user_description:
|
|
self.data["User Description"] = self.user_description
|
|
|
|
|
|
def _prepare_labels(self) -> List[str]:
|
|
pr_types = []
|
|
|
|
# If the 'PR Type' key is present in the dictionary, split its value by comma and assign it to 'pr_types'
|
|
if 'PR Type' in self.data:
|
|
if type(self.data['PR Type']) == list:
|
|
pr_types = self.data['PR Type']
|
|
elif type(self.data['PR Type']) == str:
|
|
pr_types = self.data['PR Type'].split(',')
|
|
|
|
return pr_types
|
|
|
|
def _prepare_pr_answer_with_markers(self) -> Tuple[str, str]:
|
|
get_logger().info(f"Using description marker replacements {self.pr_id}")
|
|
title = self.vars["title"]
|
|
body = self.user_description
|
|
if get_settings().pr_description.include_generated_by_header:
|
|
ai_header = f"### 🤖 Generated by PR Agent at {self.git_provider.last_commit_id.sha}\n\n"
|
|
else:
|
|
ai_header = ""
|
|
|
|
ai_summary = self.data.get('PR Description')
|
|
if ai_summary and not re.search(r'<!--\s*pr_agent:summary\s*-->', body):
|
|
summary = f"{ai_header}{ai_summary}"
|
|
body = body.replace('pr_agent:summary', summary)
|
|
|
|
if not re.search(r'<!--\s*pr_agent:walkthrough\s*-->', body):
|
|
ai_walkthrough = self.data.get('PR Main Files Walkthrough')
|
|
if ai_walkthrough:
|
|
walkthrough = str(ai_header)
|
|
for file in ai_walkthrough:
|
|
filename = file['filename'].replace("'", "`")
|
|
description = file['changes in file'].replace("'", "`")
|
|
walkthrough += f'- `{filename}`: {description}\n'
|
|
|
|
body = body.replace('pr_agent:walkthrough', walkthrough)
|
|
|
|
return title, body
|
|
|
|
def _prepare_pr_answer(self) -> Tuple[str, str]:
|
|
"""
|
|
Prepare the PR description based on the AI prediction data.
|
|
|
|
Returns:
|
|
- title: a string containing the PR title.
|
|
- pr_body: a string containing the PR description body in a markdown format.
|
|
"""
|
|
|
|
# Iterate over the dictionary items and append the key and value to 'markdown_text' in a markdown format
|
|
markdown_text = ""
|
|
for key, value in self.data.items():
|
|
markdown_text += f"## {key}\n\n"
|
|
markdown_text += f"{value}\n\n"
|
|
|
|
# Remove the 'PR Title' key from the dictionary
|
|
ai_title = self.data.pop('PR Title', self.vars["title"])
|
|
if get_settings().pr_description.keep_original_user_title:
|
|
# Assign the original PR title to the 'title' variable
|
|
title = self.vars["title"]
|
|
else:
|
|
# Assign the value of the 'PR Title' key to 'title' variable
|
|
title = ai_title
|
|
|
|
# Iterate over the remaining dictionary items and append the key and value to 'pr_body' in a markdown format,
|
|
# except for the items containing the word 'walkthrough'
|
|
pr_body = ""
|
|
for idx, (key, value) in enumerate(self.data.items()):
|
|
pr_body += f"## {key}:\n"
|
|
if 'walkthrough' in key.lower():
|
|
# for filename, description in value.items():
|
|
if self.git_provider.is_supported("gfm_markdown"):
|
|
pr_body += "<details> <summary>files:</summary>\n\n"
|
|
for file in value:
|
|
filename = file['filename'].replace("'", "`")
|
|
description = file['changes in file']
|
|
pr_body += f'`{filename}`: {description}\n'
|
|
if self.git_provider.is_supported("gfm_markdown"):
|
|
pr_body +="</details>\n"
|
|
else:
|
|
# if the value is a list, join its items by comma
|
|
if type(value) == list:
|
|
value = ', '.join(v for v in value)
|
|
pr_body += f"{value}\n"
|
|
if idx < len(self.data) - 1:
|
|
pr_body += "\n___\n"
|
|
|
|
if get_settings().config.verbosity_level >= 2:
|
|
get_logger().info(f"title:\n{title}\n{pr_body}")
|
|
|
|
return title, pr_body |