python-gitea 0.3.0__py3-none-any.whl

gitea/issue/issue.py

@@ -0,0 +1,277 @@
+"""Gitea Issue resource."""
+
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any, Literal, cast
+
+from requests import Response
+
+from gitea.issue.base import BaseIssue
+from gitea.resource.resource import Resource
+from gitea.utils.response import process_response
+
+
+class Issue(BaseIssue, Resource):
+    """Gitea Issue resource."""
+
+    def _list_issues(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        state: Literal["closed", "open", "all"] | None = None,
+        labels: list[str] | None = None,
+        search_string: str | None = None,
+        issue_type: Literal["issues", "pulls"] | None = None,
+        milestones: list[str] | list[int] | None = None,
+        since: datetime | None = None,
+        before: datetime | None = None,
+        created_by: str | None = None,
+        assigned_by: str | None = None,
+        mentioned_by: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> Response:
+        """List issues in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            state: Filter issues by state.
+            labels: Filter issues by labels.
+            search_string: Filter issues by search string.
+            issue_type: Filter by issue type.
+            milestones: Filter issues by milestones.
+            since: Filter issues updated since this time.
+            before: Filter issues updated before this time.
+            created_by: Filter issues created by this user.
+            assigned_by: Filter issues assigned to this user.
+            mentioned_by: Filter issues mentioning this user.
+            page: The page number for pagination.
+            limit: The number of issues per page.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response object.
+
+        """
+        endpoint, params = self._list_issues_helper(
+            owner=owner,
+            repository=repository,
+            state=state,
+            labels=labels,
+            search_string=search_string,
+            issue_type=issue_type,
+            milestones=milestones,
+            since=since,
+            before=before,
+            created_by=created_by,
+            assigned_by=assigned_by,
+            mentioned_by=mentioned_by,
+            page=page,
+            limit=limit,
+        )
+        return self._get(endpoint=endpoint, params=params, **kwargs)
+
+    def list_issues(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        state: Literal["closed", "open", "all"] | None = None,
+        labels: list[str] | None = None,
+        search_string: str | None = None,
+        issue_type: Literal["issues", "pulls"] | None = None,
+        milestones: list[str] | list[int] | None = None,
+        since: datetime | None = None,
+        before: datetime | None = None,
+        created_by: str | None = None,
+        assigned_by: str | None = None,
+        mentioned_by: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> tuple[list[dict[str, Any]], int]:
+        """List issues in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            state: Filter issues by state.
+            labels: Filter issues by labels.
+            search_string: Filter issues by search string.
+            issue_type: Filter by issue type.
+            milestones: Filter issues by milestones.
+            since: Filter issues updated since this time.
+            before: Filter issues updated before this time.
+            created_by: Filter issues created by this user.
+            assigned_by: Filter issues assigned to this user.
+            mentioned_by: Filter issues mentioning this user.
+            page: The page number for pagination.
+            limit: The number of issues per page.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the list of issues as a list of dictionaries and the status code.
+
+        """
+        response = self._list_issues(
+            owner=owner,
+            repository=repository,
+            state=state,
+            labels=labels,
+            search_string=search_string,
+            issue_type=issue_type,
+            milestones=milestones,
+            since=since,
+            before=before,
+            created_by=created_by,
+            assigned_by=assigned_by,
+            mentioned_by=mentioned_by,
+            page=page,
+            limit=limit,
+            **kwargs,
+        )
+        data, status_code = process_response(response)
+        return cast(list[dict[str, Any]], data), status_code
+
+    def _get_issue(self, owner: str, repository: str, index: int, **kwargs: Any) -> Response:
+        """Get a single issue by its index.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response object.
+
+        """
+        endpoint = self._get_issue_helper(owner=owner, repository=repository, index=index)
+        return self._get(endpoint=endpoint, **kwargs)
+
+    def get_issue(self, owner: str, repository: str, index: int, **kwargs: Any) -> tuple[dict[str, Any], int]:
+        """Get a single issue by its index.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the issue as a dictionary and the status code.
+
+        """
+        response = self._get_issue(owner=owner, repository=repository, index=index, **kwargs)
+        data, status_code = process_response(response)
+        return cast(dict[str, Any], data), status_code
+
+    def _edit_issue(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        index: int,
+        assignee: str | None = None,
+        assignees: list[str] | None = None,
+        body: str | None = None,
+        due_date: datetime | None = None,
+        milestone: int | None = None,
+        ref: str | None = None,
+        state: Literal["closed", "open"] | None = None,
+        title: str | None = None,
+        unset_due_date: bool | None = None,
+        **kwargs: Any,
+    ) -> Response:
+        """Edit a specific issue in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            assignee: The new assignee of the issue.
+            assignees: The new assignees of the issue.
+            body: The new body of the issue.
+            due_date: The new due date of the issue.
+            milestone: The new milestone of the issue.
+            ref: The new reference of the issue.
+            state: The new state of the issue.
+            title: The new title of the issue.
+            unset_due_date: Whether to unset the due date of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response object.
+
+        """
+        endpoint, payload = self._edit_issue_helper(
+            owner=owner,
+            repository=repository,
+            index=index,
+            assignee=assignee,
+            assignees=assignees,
+            body=body,
+            due_date=due_date,
+            milestone=milestone,
+            ref=ref,
+            state=state,
+            title=title,
+            unset_due_date=unset_due_date,
+        )
+        return self._patch(endpoint=endpoint, json=payload, **kwargs)
+
+    def edit_issue(  # noqa: PLR0913
+        self,
+        owner: str,
+        repository: str,
+        index: int,
+        assignee: str | None = None,
+        assignees: list[str] | None = None,
+        body: str | None = None,
+        due_date: datetime | None = None,
+        milestone: int | None = None,
+        ref: str | None = None,
+        state: Literal["closed", "open"] | None = None,
+        title: str | None = None,
+        unset_due_date: bool | None = None,
+        **kwargs: Any,
+    ) -> tuple[dict[str, Any], int]:
+        """Edit a specific issue in a repository.
+
+        Args:
+            owner: The owner of the repository.
+            repository: The name of the repository.
+            index: The index of the issue.
+            assignee: The new assignee of the issue.
+            assignees: The new assignees of the issue.
+            body: The new body of the issue.
+            due_date: The new due date of the issue.
+            milestone: The new milestone of the issue.
+            ref: The new reference of the issue.
+            state: The new state of the issue.
+            title: The new title of the issue.
+            unset_due_date: Whether to unset the due date of the issue.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the edited issue as a dictionary and the status code.
+
+        """
+        response = self._edit_issue(
+            owner=owner,
+            repository=repository,
+            index=index,
+            assignee=assignee,
+            assignees=assignees,
+            body=body,
+            due_date=due_date,
+            milestone=milestone,
+            ref=ref,
+            state=state,
+            title=title,
+            unset_due_date=unset_due_date,
+            **kwargs,
+        )
+        data, status_code = process_response(response)
+        return cast(dict[str, Any], data), status_code

gitea/resource/__init__.py

@@ -0,0 +1 @@
+"""Resource module for Gitea API."""

gitea/resource/async_resource.py

@@ -0,0 +1,87 @@
+"""Asynchronous Resource Base Class for Gitea API interactions."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from aiohttp import ClientResponse
+
+from gitea.client.async_gitea import AsyncGitea
+
+
+class AsyncResource:
+    """Base class for asynchronous Gitea API resources."""
+
+    def __init__(self, client: AsyncGitea) -> None:
+        """Initialize the Resource with a AsyncGitea client.
+
+        Args:
+            client: An instance of the AsyncGitea client.
+
+        """
+        self.client = client
+
+    async def _get(self, endpoint: str, **kwargs: Any) -> ClientResponse:
+        """Perform a GET request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The response as a ClientResponse object.
+
+        """
+        return await self.client._request(method="GET", endpoint=endpoint, **kwargs)
+
+    async def _post(self, endpoint: str, **kwargs: Any) -> ClientResponse:
+        """Perform a POST request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The response as a ClientResponse object.
+
+        """
+        return await self.client._request(method="POST", endpoint=endpoint, **kwargs)
+
+    async def _put(self, endpoint: str, **kwargs: Any) -> ClientResponse:
+        """Perform a PUT request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The response as a ClientResponse object.
+
+        """
+        return await self.client._request(method="PUT", endpoint=endpoint, **kwargs)
+
+    async def _delete(self, endpoint: str, **kwargs: Any) -> ClientResponse:
+        """Perform a DELETE request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The response as a ClientResponse object.
+
+        """
+        return await self.client._request(method="DELETE", endpoint=endpoint, **kwargs)
+
+    async def _patch(self, endpoint: str, **kwargs: Any) -> ClientResponse:
+        """Perform a PATCH request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The response as a ClientResponse object.
+
+        """
+        return await self.client._request(method="PATCH", endpoint=endpoint, **kwargs)

gitea/resource/resource.py

@@ -0,0 +1,88 @@
+"""Base class for Gitea API resources."""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
+from requests import Response
+
+if TYPE_CHECKING:
+    from gitea.client.gitea import Gitea
+
+
+class Resource:
+    """Base class for Gitea API resources."""
+
+    def __init__(self, client: Gitea) -> None:
+        """Initialize the Resource with a Gitea client.
+
+        Args:
+            client: An instance of the Gitea client.
+
+        """
+        self.client = client
+
+    def _get(self, endpoint: str, **kwargs: Any) -> Response:
+        """Perform a GET request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response.
+
+        """
+        return self.client._request(method="GET", endpoint=endpoint, **kwargs)
+
+    def _post(self, endpoint: str, **kwargs: Any) -> Response:
+        """Perform a POST request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response.
+
+        """
+        return self.client._request(method="POST", endpoint=endpoint, **kwargs)
+
+    def _put(self, endpoint: str, **kwargs: Any) -> Response:
+        """Perform a PUT request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response.
+
+        """
+        return self.client._request(method="PUT", endpoint=endpoint, **kwargs)
+
+    def _delete(self, endpoint: str, **kwargs: Any) -> Response:
+        """Perform a DELETE request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response.
+
+        """
+        return self.client._request(method="DELETE", endpoint=endpoint, **kwargs)
+
+    def _patch(self, endpoint: str, **kwargs: Any) -> Response:
+        """Perform a PATCH request.
+
+        Args:
+            endpoint: The API endpoint.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The HTTP response.
+
+        """
+        return self.client._request(method="PATCH", endpoint=endpoint, **kwargs)

gitea/user/__init__.py

@@ -0,0 +1 @@
+"""User module for Gitea API."""

gitea/user/async_user.py

@@ -0,0 +1,129 @@
+"""Asynchronous User Resource for Gitea API."""
+
+from __future__ import annotations
+
+from typing import Any, cast
+
+from aiohttp import ClientResponse
+
+from gitea.resource.async_resource import AsyncResource
+from gitea.user.base import BaseUser
+from gitea.utils.response import process_async_response
+
+
+class AsyncUser(BaseUser, AsyncResource):
+    """Asynchronous Gitea User resource."""
+
+    async def _get_user(self, username: str | None = None, **kwargs: Any) -> ClientResponse:
+        """Asynchronously get user information.
+
+        Args:
+            username: The username of the user to retrieve. If None, retrieves the authenticated user.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The authenticated user's information as a ClientResponse object.
+
+        """
+        endpoint, kwargs = self._get_user_helper(username=username, **kwargs)
+        return await self._get(endpoint=endpoint, **kwargs)
+
+    async def get_user(self, username: str | None = None, **kwargs: Any) -> tuple[dict[str, Any], int]:
+        """Asynchronously get user information.
+
+        Args:
+            username: The username of the user to retrieve. If None, retrieves the authenticated user.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the user information as a dictionary and the status code.
+
+        """
+        response = await self._get_user(username=username, **kwargs)
+        data, status_code = await process_async_response(response)
+        return cast(dict[str, Any], data), status_code
+
+    async def _update_user_settings(  # noqa: PLR0913
+        self,
+        diff_view_style: str | None = None,
+        full_name: str | None = None,
+        hide_activity: bool | None = None,
+        hide_email: bool | None = None,
+        language: str | None = None,
+        location: str | None = None,
+        theme: str | None = None,
+        website: str | None = None,
+        **kwargs: Any,
+    ) -> ClientResponse:
+        """Asynchronously update user settings.
+
+        Args:
+            diff_view_style: The preferred diff view style.
+            full_name: The full name of the user.
+            hide_activity: Whether to hide user activity.
+            hide_email: Whether to hide user email.
+            language: The preferred language.
+            location: The location of the user.
+            theme: The preferred theme.
+            website: The user's website.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            The response as a ClientResponse object.
+
+        """
+        endpoint, payload, kwargs = self._update_user_settings_helper(
+            diff_view_style=diff_view_style,
+            full_name=full_name,
+            hide_activity=hide_activity,
+            hide_email=hide_email,
+            language=language,
+            location=location,
+            theme=theme,
+            website=website,
+            **kwargs,
+        )
+        return await self._patch(endpoint=endpoint, json=payload, **kwargs)
+
+    async def update_user_settings(  # noqa: PLR0913
+        self,
+        diff_view_style: str | None = None,
+        full_name: str | None = None,
+        hide_activity: bool | None = None,
+        hide_email: bool | None = None,
+        language: str | None = None,
+        location: str | None = None,
+        theme: str | None = None,
+        website: str | None = None,
+        **kwargs: Any,
+    ) -> tuple[dict[str, Any], int]:
+        """Asynchronously update user settings.
+
+        Args:
+            diff_view_style: The preferred diff view style.
+            full_name: The full name of the user.
+            hide_activity: Whether to hide user activity.
+            hide_email: Whether to hide user email.
+            language: The preferred language.
+            location: The location of the user.
+            theme: The preferred theme.
+            website: The user's website.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the updated user settings as a dictionary and the status code.
+
+        """
+        response = await self._update_user_settings(
+            diff_view_style=diff_view_style,
+            full_name=full_name,
+            hide_activity=hide_activity,
+            hide_email=hide_email,
+            language=language,
+            location=location,
+            theme=theme,
+            website=website,
+            **kwargs,
+        )
+        data, status_code = await process_async_response(response)
+        return cast(dict[str, Any], data), status_code

gitea/user/base.py

@@ -0,0 +1,113 @@
+"""Base class for Gitea User resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class BaseUser:
+    """Base class for Gitea User resource."""
+
+    def _get_user_endpoint(self, username: str | None) -> str:
+        """Determine the user endpoint based on username or account ID.
+
+        Args:
+            username: The username of the user.
+
+        Returns:
+            The API endpoint for the user.
+
+        """
+        return "/user" if username is None else f"/users/{username}"
+
+    def _get_user_helper(self, username: str | None = None, **kwargs: Any) -> tuple[str, dict[str, Any]]:
+        """Get user information.
+
+        Args:
+            username: The username of the user to retrieve. If None, retrieves the authenticated user.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the endpoint and the request arguments.
+                - The API endpoint for the user.
+                - A dictionary of request arguments.
+
+        """
+        endpoint = self._get_user_endpoint(username=username)
+        default_headers = {
+            "Content-Type": "application/json",
+        }
+        headers = kwargs.get("headers", {})
+        headers = {**default_headers, **headers}
+        kwargs["headers"] = headers
+
+        return endpoint, kwargs
+
+    def _update_user_settings_endpoint(self) -> str:
+        """Get the endpoint for updating user settings.
+
+        Returns:
+            The API endpoint for updating user settings.
+
+        """
+        return "/user/settings"
+
+    def _update_user_settings_helper(  # noqa: PLR0913
+        self,
+        diff_view_style: str | None = None,
+        full_name: str | None = None,
+        hide_activity: bool | None = None,
+        hide_email: bool | None = None,
+        language: str | None = None,
+        location: str | None = None,
+        theme: str | None = None,
+        website: str | None = None,
+        **kwargs: Any,
+    ) -> tuple[str, dict[str, Any], dict[str, Any]]:
+        """Get the endpoint and request arguments for updating user settings.
+
+        Args:
+            diff_view_style: The preferred diff view style.
+            full_name: The full name of the user.
+            hide_activity: Whether to hide the user's activity.
+            hide_email: Whether to hide the user's email.
+            language: The preferred language.
+            location: The location of the user.
+            theme: The preferred theme.
+            website: The user's website.
+            **kwargs: Additional arguments for the request.
+
+        Returns:
+            A tuple containing the endpoint, payload, and request arguments.
+                - The API endpoint for updating user settings.
+                - A dictionary representing the payload for the request.
+                - A dictionary of request arguments.
+
+        """
+        endpoint = self._update_user_settings_endpoint()
+        default_headers = {
+            "Content-Type": "application/json",
+        }
+        headers = kwargs.get("headers", {})
+        headers = {**default_headers, **headers}
+        kwargs["headers"] = headers
+
+        payload = {}
+        if diff_view_style is not None:
+            payload["diff_view_style"] = diff_view_style
+        if full_name is not None:
+            payload["full_name"] = full_name
+        if hide_activity is not None:
+            payload["hide_activity"] = hide_activity
+        if hide_email is not None:
+            payload["hide_email"] = hide_email
+        if language is not None:
+            payload["language"] = language
+        if location is not None:
+            payload["location"] = location
+        if theme is not None:
+            payload["theme"] = theme
+        if website is not None:
+            payload["website"] = website
+
+        return endpoint, payload, kwargs