Skip to content

[Penify] Full Repo Documentation #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
penify-dev wants to merge 1 commit into from
Closed

[Penify] Full Repo Documentation #60

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
266 changes: 193 additions & 73 deletions penify_hook/api_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,33 +5,76 @@

class APIClient:
def __init__(self, api_url, api_token: str = None, bearer_token: str = None):
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""
self.api_url = api_url
self.AUTH_TOKEN = api_token
self.BEARER_TOKEN = bearer_token

def send_file_for_docstring_generation(self, file_name, content, line_numbers, repo_details = None):
"""Send file content and modified lines to the API and return modified
content.

This function constructs a payload containing the file path, content,
and modified line numbers, and sends it to a specified API endpoint for
processing. It handles the response from the API, returning the modified
content if the request is successful. If the request fails, it logs the
error details and returns the original content.

Args:
file_name (str): The path to the file being sent.
content (str): The content of the file to be processed.
line_numbers (list): A list of line numbers that have been modified.
repo_details (str?): Additional repository details if applicable. Defaults to None.

Returns:
str: The modified content returned by the API, or the original content if the
request fails.

Raises:
Exception: If there is an error in processing the file and no specific error
message is provided.
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""
payload = {
'file_path': file_name,
Expand All @@ -53,25 +96,38 @@ def send_file_for_docstring_generation(self, file_name, content, line_numbers, r
raise Exception(f"API Error: {error_message}")

def generate_commit_summary(self, git_diff, instruction: str = "", repo_details = None, jira_context: dict = None):
"""Generate a commit summary by sending a POST request to the API endpoint.

This function constructs a payload containing the git diff and any
additional instructions provided. It then sends this payload to a
specified API endpoint to generate a summary of the commit. If the
request is successful, it returns the response from the API; otherwise,
it returns None.

Args:
git_diff (str): The git diff of the commit.
instruction (str??): Additional instruction for the commit. Defaults to "".
repo_details (dict??): Details of the git repository. Defaults to None.
jira_context (dict??): JIRA issue details to enhance the commit summary. Defaults to None.

Returns:
dict: The response from the API if the request is successful, None otherwise.

Raises:
Exception: If there is an error during the API request.
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""
payload = {
'git_diff': git_diff,
Expand Down Expand Up @@ -100,18 +156,40 @@ def generate_commit_summary(self, git_diff, instruction: str = "", repo_details
return None

def get_supported_file_types(self) -> list[str]:
"""Retrieve the supported file types from the API.

This function sends a request to the API endpoint
`/v1/file/supported_languages` to obtain a list of supported file types.
If the API call is successful (status code 200), it parses the JSON
response and returns the list of supported file types. If the API call
fails, it returns a default list of common file types.

Returns:
list[str]: A list of supported file types, either from the API or a default set.
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""

url = self.api_url+"/v1/file/supported_languages"
response = requests.get(url)
if response.status_code == 200:
Expand All @@ -121,20 +199,38 @@ def get_supported_file_types(self) -> list[str]:
return ["py", "js", "ts", "java", "kt", "cs", "c"]

def generate_commit_summary_with_llm(self, diff, message, generate_description: bool, repo_details, llm_client : LLMClient, jira_context=None):
"""Generates a commit summary using a local LLM client. If an error occurs
during the generation process,
it falls back to using the API.

Args:
diff (str): The Git diff of changes.
message (str): User-provided commit message or instructions.
generate_description (bool): Flag indicating whether to generate a description for the commit.
repo_details (dict): Details about the repository.
llm_client (LLMClient): An instance of LLMClient used to generate the summary.
jira_context (JIRAContext?): Optional JIRA issue context to enhance the summary.

Returns:
dict: A dictionary containing the title and description for the commit.
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""
try:
return llm_client.generate_commit_summary(diff, message, generate_description, repo_details, jira_context)
Expand All @@ -144,17 +240,41 @@ def generate_commit_summary_with_llm(self, diff, message, generate_description:
return self.generate_commit_summary(diff, message, repo_details, jira_context)

def get_api_key(self):
"""Fetch an API key from a specified URL.

This function sends a GET request to retrieve an API token using a
Bearer token in the headers. It handles the response and returns the API
key if the request is successful, or `None` otherwise.

Returns:
str: The API key if the request is successful, `None` otherwise.
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""


url = self.api_url+"/v1/apiToken/get"
response = requests.get(url, headers={"Authorization": f"Bearer {self.BEARER_TOKEN}"}, timeout=60*10)
if response.status_code == 200:
Expand Down
33 changes: 33 additions & 0 deletions penify_hook/base_analyzer.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,39 @@
class BaseAnalyzer:

def __init__(self, folder_path: str, api_client: APIClient):
"""Save the processed files map to a JSON file.

Function parameters should be documented in the ``Args`` section. The name of each parameter is required. The type and
description of each parameter is optional, but should be included if not obvious.


Parameters
----------
dictionary : dict
The processed files map.

Returns
-------
bool
True if successful, False otherwise.

The return type is optional and may be specified at the beginning of

the ``Returns`` section followed by a colon.

The ``Returns`` section may span multiple lines and paragraphs.

Following lines should be indented to match the first line.

The ``Returns`` section supports any reStructuredText formatting,

including literal blocks::

{
'param1': param1,
'param2': param2
}
"""
self.folder_path = folder_path
self.repo_path = recursive_search_git_folder(folder_path)
self.repo = None
Expand Down
Loading
Loading