From eeac3632b14d0a5a583e00b845569ad2d3a90cfe Mon Sep 17 00:00:00 2001 From: "Jon Michael Aanes (aider)" Date: Sun, 13 Apr 2025 18:27:05 +0200 Subject: [PATCH 1/2] docs: Add comprehensive documentation to GiteaClient class --- aider_gitea/__main__.py | 71 +++++++++++++++++++++++++++++++++++++---- 1 file changed, 65 insertions(+), 6 deletions(-) diff --git a/aider_gitea/__main__.py b/aider_gitea/__main__.py index be2f53b..a71da7a 100644 --- a/aider_gitea/__main__.py +++ b/aider_gitea/__main__.py @@ -95,7 +95,27 @@ def create_aider_command(issue: str) -> list[str]: class GiteaClient: + """ + Client for interacting with the Gitea API. + + This class provides methods to interact with a Gitea instance's API, + including retrieving repository information, creating branches, and fetching issues. + + Attributes: + gitea_url (str): The base URL for the Gitea API endpoints. + session (requests.Session): HTTP session for making API requests. + """ def __init__(self, gitea_url: str, token: str) -> None: + """ + Initialize a new Gitea API client. + + Args: + gitea_url (str): Base URL for the Gitea instance (without '/api/v1'). + token (str): Authentication token for the Gitea API. If empty, requests will be unauthenticated. + + Raises: + AssertionError: If gitea_url ends with '/api/v1'. + """ assert not gitea_url.endswith('/api/v1') self.gitea_url = gitea_url + '/api/v1' self.session = requests.Session() @@ -103,16 +123,43 @@ class GiteaClient: if token: self.session.headers['Authorization'] = f'token {token}' - def get_default_branch_sha(self, owner, repo, branch): - """Retrieve the commit SHA of the default branch.""" + def get_default_branch_sha(self, owner: str, repo: str, branch: str) -> str: + """ + Retrieve the commit SHA of the specified branch. + + Args: + owner (str): Owner of the repository. + repo (str): Name of the repository. + branch (str): Name of the branch. + + Returns: + str: The commit SHA of the specified branch. + + Raises: + requests.HTTPError: If the API request fails. + """ url = f'{self.gitea_url}/repos/{owner}/{repo}/branches/{branch}' response = self.session.get(url) response.raise_for_status() data = response.json() return data['commit']['sha'] - def create_branch(self, owner, repo, new_branch, sha): - """Create a new branch from the provided SHA.""" + def create_branch(self, owner: str, repo: str, new_branch: str, sha: str) -> bool: + """ + Create a new branch from the provided SHA. + + Args: + owner (str): Owner of the repository. + repo (str): Name of the repository. + new_branch (str): Name of the new branch to create. + sha (str): Commit SHA to use as the starting point for the new branch. + + Returns: + bool: True if the branch was created successfully, False if the branch already exists. + + Raises: + requests.HTTPError: If the API request fails for reasons other than branch already existing. + """ url = f'{self.gitea_url}/repos/{owner}/{repo}/git/refs' json_data = {'ref': f'refs/heads/{new_branch}', 'sha': sha} response = self.session.post(url, json=json_data) @@ -122,8 +169,20 @@ class GiteaClient: response.raise_for_status() return True - def get_issues(self, owner, repo): - """Download issues from the specified repository and filter those with the aider label.""" + def get_issues(self, owner: str, repo: str) -> list: + """ + Download issues from the specified repository and filter those with the 'aider' label. + + Args: + owner (str): Owner of the repository. + repo (str): Name of the repository. + + Returns: + list: A list of issue dictionaries, filtered to only include issues with the 'aider' label. + + Raises: + requests.HTTPError: If the API request fails. + """ url = f'{self.gitea_url}/repos/{owner}/{repo}/issues' response = self.session.get(url) response.raise_for_status() -- 2.45.1 From 77739b0004d0a5bdb5b83caf0f46ff91884b75d0 Mon Sep 17 00:00:00 2001 From: Jon Michael Aanes Date: Sun, 13 Apr 2025 18:27:10 +0200 Subject: [PATCH 2/2] Ruff --- aider_gitea/__main__.py | 33 +++++++++++++++++++-------------- 1 file changed, 19 insertions(+), 14 deletions(-) diff --git a/aider_gitea/__main__.py b/aider_gitea/__main__.py index a71da7a..176f2a1 100644 --- a/aider_gitea/__main__.py +++ b/aider_gitea/__main__.py @@ -97,22 +97,23 @@ def create_aider_command(issue: str) -> list[str]: class GiteaClient: """ Client for interacting with the Gitea API. - + This class provides methods to interact with a Gitea instance's API, including retrieving repository information, creating branches, and fetching issues. - + Attributes: gitea_url (str): The base URL for the Gitea API endpoints. session (requests.Session): HTTP session for making API requests. """ + def __init__(self, gitea_url: str, token: str) -> None: """ Initialize a new Gitea API client. - + Args: gitea_url (str): Base URL for the Gitea instance (without '/api/v1'). token (str): Authentication token for the Gitea API. If empty, requests will be unauthenticated. - + Raises: AssertionError: If gitea_url ends with '/api/v1'. """ @@ -126,15 +127,15 @@ class GiteaClient: def get_default_branch_sha(self, owner: str, repo: str, branch: str) -> str: """ Retrieve the commit SHA of the specified branch. - + Args: owner (str): Owner of the repository. repo (str): Name of the repository. branch (str): Name of the branch. - + Returns: str: The commit SHA of the specified branch. - + Raises: requests.HTTPError: If the API request fails. """ @@ -147,16 +148,16 @@ class GiteaClient: def create_branch(self, owner: str, repo: str, new_branch: str, sha: str) -> bool: """ Create a new branch from the provided SHA. - + Args: owner (str): Owner of the repository. repo (str): Name of the repository. new_branch (str): Name of the new branch to create. sha (str): Commit SHA to use as the starting point for the new branch. - + Returns: bool: True if the branch was created successfully, False if the branch already exists. - + Raises: requests.HTTPError: If the API request fails for reasons other than branch already existing. """ @@ -172,14 +173,14 @@ class GiteaClient: def get_issues(self, owner: str, repo: str) -> list: """ Download issues from the specified repository and filter those with the 'aider' label. - + Args: owner (str): Owner of the repository. repo (str): Name of the repository. - + Returns: list: A list of issue dictionaries, filtered to only include issues with the 'aider' label. - + Raises: requests.HTTPError: If the API request fails. """ @@ -296,7 +297,11 @@ def solve_issue_in_repository( run_cmd(['git', 'checkout', '-b', branch_name], tmpdirname) # Run aider - succeeded = run_cmd(create_aider_command(f'# {issue_title}\n{issue_description}'), tmpdirname, check=False) + succeeded = run_cmd( + create_aider_command(f'# {issue_title}\n{issue_description}'), + tmpdirname, + check=False, + ) if not succeeded: logger.error('Aider invocation failed for issue #%s', issue_number) return False -- 2.45.1