gatorsmile commented on code in PR #41711: URL: https://github.com/apache/spark/pull/41711#discussion_r1240869830
########## dev/error_message_refiner.py: ########## @@ -0,0 +1,235 @@ +#!/usr/bin/env python3 + +# +# Licensed to the Apache Software Foundation (ASF) under one or more +# contributor license agreements. See the NOTICE file distributed with +# this work for additional information regarding copyright ownership. +# The ASF licenses this file to You under the Apache License, Version 2.0 +# (the "License"); you may not use this file except in compliance with +# the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. +# + +""" +Utility for refining error messages based on LLM. + +Usage: + python error_message_refiner.py <error_class> [--gpt_version=<version>] + +Arguments: + <error_class> Required. + The name of the error class to refine the messages for. + The list of error classes is located in + `core/src/main/resources/error/error-classes.json`. + +Options: + --gpt_version=<version> Optional. + The version of Chat GPT to use for refining the error messages. + If not provided, the default version("gpt-3.5-turbo") will be used. + +Example usage: + python error_message_refiner.py CANNOT_DECODE_URL --gpt_version=gpt-4 + +Description: + This script refines error messages using the LLM based approach. + It takes the name of the error class as a required argument and, optionally, + allows specifying the version of Chat GPT to use for refining the messages. + + Options: + --gpt_version: Specifies the version of Chat GPT. + If not provided, the default version("gpt-3.5-turbo") will be used. + + Note: + - Ensure that the necessary dependencies are installed before running the script. + - Ensure that the valid API key is entered in the `api-key.txt`. + - The refined error messages will be displayed in the console output. + - To use the gpt-4 model, you need to join the waitlist. Please refer to + https://help.openai.com/en/articles/7102672-how-can-i-access-gpt-4 for more details. +""" + +import argparse +import json +import openai +import re +import subprocess +import random +from typing import Tuple, Optional +from sparktestsupport import SPARK_HOME + +PATH_TO_ERROR_CLASS = f"{SPARK_HOME}/core/src/main/resources/error/error-classes.json" +PATH_TO_API_KEY = f"{SPARK_HOME}/dev/api_key.txt" + +# You can obtain an API key from https://platform.openai.com/account/api-keys +openai.api_key = open(PATH_TO_API_KEY).read().rstrip("\n") + + +def _git_grep_files(search_string: str, exclude: str = None) -> str: + """ + Executes 'git grep' command to search for files containing the given search string. + Returns the file path where the search string is found. + """ + result = subprocess.run( + ["git", "grep", "-l", search_string, "--", f"{SPARK_HOME}/*.scala"], + capture_output=True, + text=True, + ) + output = result.stdout.strip() + + files = output.split("\n") + files = [file for file in files if "Suite" not in file] + if exclude is not None: + files = [file for file in files if exclude not in file] + file = random.choice(files) + return file + + +def _find_function(file_name: str, search_string: str) -> Optional[str]: + """ + Searches for a function in the given file containing the specified search string. + Returns the name of the function if found, otherwise None. + """ + with open(file_name, "r") as file: + content = file.read() + functions = re.findall(r"def\s+(\w+)\s*\(", content) + + for function in functions: + function_content = re.search( + rf"def\s+{re.escape(function)}(?:(?!def).)*?{re.escape(search_string)}", + content, + re.DOTALL, + ) + if function_content and search_string in function_content.group(0): + return function + + return None + + +def _find_func_body(file_name: str, search_string: str) -> Optional[str]: + """ + Searches for a function body in the given file containing the specified search string. + Returns the function body if found, otherwise None. + """ + with open(file_name, "r") as file: + content = file.read() + functions = re.findall(r"def\s+(\w+)\s*\(", content) + + for function in functions: + function_content = re.search( + rf"def\s+{re.escape(function)}(?:(?!def\s).)*?{re.escape(search_string)}", + content, + re.DOTALL, + ) + if function_content and search_string in function_content.group(0): + return function_content.group(0) + + return None + + +def _get_error_function(error_class: str) -> str: + """ + Retrieves the name of the error function that triggers the given error class. + """ + search_string = error_class + matched_file = _git_grep_files(search_string) + err_func = _find_function(matched_file, search_string) + return err_func + + +def _get_source_code(error_class: str) -> str: + """ + Retrieves the source code of a function where the given error class is being invoked. + """ + search_string = error_class + matched_file = _git_grep_files(search_string) + err_func = _find_function(matched_file, search_string) + source_file = _git_grep_files(err_func, exclude=matched_file) + source_code = _find_func_body(source_file, err_func) + return source_code + + +def _get_error_message(error_class: str) -> str: + """ + Returns the error message from the provided error class + listed in core/src/main/resources/error/error-classes.json. + """ + with open(PATH_TO_ERROR_CLASS) as f: + error_classes = json.load(f) + + error_message = error_classes.get(error_class) + if error_message: + return error_message["message"] + else: + return f"Error message not found for class: {error_class}" + + +def ask_chat_gpt(error_class: str, gpt_version: str) -> Tuple[str, str]: + """ + Requests error message improvement from Chat GPT. + Returns a tuple containing the old error message and the refined error message. + """ + old_error_message = " ".join(_get_error_message(error_class)) + error_function = _get_error_function(error_class) + source_code = _get_source_code(error_class) + message = ( + "I want to improve the error message.\n" + "The error message should be user-friendly, " + "providing a clear description of the error's cause, " + "as well as suggesting the best possible actions for the user to take.\n" + f'Please improve the following error message: "{old_error_message}"\n' + "PLEASE NOTE that the angle brackets in the error message represent the placeholder " + "for the error message parameter, so they should not be modified or removed." + f"For more detail, the error message is triggered through a error function " + f'named "{error_function}", and the source code that actually calls the error function ' + f"is as follows:\n\n{source_code}\n\n" + "When improving the error, please also refer to the source code provided above " + "to provide the user with more useful information.\n" + "Also, please only show improved error message without any additional explanation " + "so that I can just copy and paste your answer.\n" Review Comment: https://spark.apache.org/error-message-guidelines.html is the guideline. Let us add them to the prompt. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org --------------------------------------------------------------------- To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org For additional commands, e-mail: reviews-h...@spark.apache.org
