feat: Add documentation review prompt (#83)

Co-authored-by: Maxime Rey <87315832+MaxJPRey@users.noreply.github.com>

Author: AlejandroFernandezLuces

.gitignore

@@ -157,3 +157,4 @@ cython_debug/
 #.idea/
 
 # End of https://www.toptal.com/developers/gitignore/api/python
+.vscode/

.pre-commit-config.yaml

@@ -8,17 +8,15 @@ repos:
   - id: isort
 
 - repo: https://github.com/psf/black
-  rev: 23.7.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
+  rev: 23.9.1  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
-    args:
-      - --line-length=88
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 1.15.0
   hooks:
   - id: blacken-docs
-    additional_dependencies: [black==23.7.0]
+    additional_dependencies: [black==23.9.1]
 
 - repo: https://github.com/PyCQA/flake8
   rev: 6.1.0

src/review/bot/__init__.py

@@ -1,4 +1,3 @@
-# Copyright (c) 2023 ANSYS, Inc. All rights reserved
 """OpenAI LLM powered Review-bot."""
 
 try:
@@ -9,4 +8,4 @@
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 
 from .misc import open_logger
-from .open_ai_interface import review_patch, review_patch_local
+from .open_ai_interface import review_file, review_folder, review_patch, review_patch_local

src/review/bot/gh_interface.py

@@ -13,9 +13,7 @@
 
 def _fetch_file_content(file_data, headers):
     """Fetch the content of a single file."""
-    content_response = requests.get(
-        file_data["contents_url"], headers=headers, timeout=10
-    )
+    content_response = requests.get(file_data["contents_url"], headers=headers, timeout=10)
 
     if content_response.status_code == 200:
         content = content_response.json()
@@ -73,28 +71,15 @@ def get_changed_files_and_contents(owner, repo, pull_number, gh_access_token=Non
 
     """
     access_token = _get_gh_token() if gh_access_token is None else gh_access_token
-    url = f"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}"
-    # url = f"https://github.com/{owner}/{repo}/pull/{pull_number}.diff"
-    headers = {
-        "Authorization": f"Bearer {access_token}",
-        # "Content-type": "application/vnd.github.diff",
-    }
-
-    response = requests.get(url, headers=headers, timeout=10)
-    if response.status_code != 200:
-        raise RuntimeError(
-            f"Error fetching pull request files from:\n{url}\n\n{response.status_code}"
-        )
-
-    files = response.json()
 
     url = f"https://api.github.com/repos/{owner}/{repo}/pulls/{pull_number}/files"
     headers = {"Authorization": f"Bearer {access_token}"}
     response = requests.get(url, headers=headers, timeout=10)
 
     if response.status_code != 200:
-        print(f"Error fetching pull request files: {response.status_code}")
-        return
+        raise RuntimeError(
+            f"Error fetching pull request files from:\n{url}\n\n{response.status_code}"
+        )
 
     files = response.json()
     threads = []

src/review/bot/misc.py

@@ -71,17 +71,13 @@ def get_client(config_file: str = None) -> Union[OpenAI, AzureOpenAI]:
         raise OSError('Missing "OPEN_AI_TOKEN" environment variable')
 
     if api_type == "azure":
-        client = AzureOpenAI(
-            azure_endpoint=api_base, api_key=access_token, api_version=api_version
-        )
+        client = AzureOpenAI(azure_endpoint=api_base, api_key=access_token, api_version=api_version)
     else:
         client = OpenAI(api_key=access_token)
     return client
 
 
-def open_logger(
-    loglevel="DEBUG", formatstr="%(name)-20s - %(levelname)-8s - %(message)s"
-):
+def open_logger(loglevel="DEBUG", formatstr="%(name)-20s - %(levelname)-8s - %(message)s"):
     """Start logging to standard output.
 
     Parameters
@@ -301,13 +297,9 @@ def parse_suggestions(text_block: str):
                     "Suggestion does not contain a path to a file in the proper position, it will be ignored."
                 )
         else:
-            LOG.warning(
-                "Suggestion is missing some section, this suggestion will be ignored."
-            )
+            LOG.warning("Suggestion is missing some section, this suggestion will be ignored.")
     if not validate_output(suggestions):
-        raise ValidationErrorException(
-            "Output format is not well formed.", llm_output=text_block
-        )
+        raise ValidationErrorException("Output format is not well formed.", llm_output=text_block)
     if len(suggestions) == 0:
         raise ValidationErrorException(
             "Output is empty due to all suggestions being malformed.",