python-gitea 0.3.1__tar.gz → 0.4.0__tar.gz

python_gitea-0.4.0/.github/workflows/semantic_pull_request.yml

@@ -0,0 +1,20 @@
+name: "Lint PR"
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - reopened
+      - edited
+      - synchronize
+
+jobs:
+  main:
+    name: Validate PR title
+    runs-on: ubuntu-slim
+    permissions:
+      pull-requests: read
+    steps:
+      - uses: amannn/action-semantic-pull-request@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

{python_gitea-0.3.1 → python_gitea-0.4.0}/.pre-commit-config.yaml

@@ -50,7 +50,7 @@ repos:
         stages: [pre-commit]
 
   - repo: https://github.com/astral-sh/ruff-pre-commit
-    rev: v0.14.13
+    rev: v0.14.14
     hooks:
       - id: ruff
         args: [--fix, --config=pyproject.toml]
@@ -77,7 +77,7 @@ repos:
         stages: [pre-commit]
 
   - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v9.4.0 # Keep this version or update to the latest stable
+    rev: v9.6.0 # Keep this version or update to the latest stable
     hooks:
       - id: cspell
         name: Check spelling in Python, reSt, and Markdown files.

{python_gitea-0.3.1 → python_gitea-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: python-gitea
-Version: 0.3.1
+Version: 0.4.0
 Summary: A Python package for interacting with the Gitea API, offering a simple interface to access repositories, users, organizations, issues, and more for automation and data management.
 Project-URL: Documentation, https://isaac-cf-wong.github.io/python-gitea
 Project-URL: Source, https://github.com/isaac-cf-wong/python-gitea

{python_gitea-0.3.1 → python_gitea-0.4.0}/mkdocs.yml

@@ -82,6 +82,10 @@ nav:
               - Overview: reference/gitea/resource/index.md
               - Resource: reference/gitea/resource/resource.md
               - Async Resource: reference/gitea/resource/async_resource.md
+          - Repository:
+              - Overview: reference/gitea/repository/index.md
+              - Repository: reference/gitea/repository/repository.md
+              - Async Repository: reference/gitea/repository/async_repository.md
           - Issue:
               - Overview: reference/gitea/issue/index.md
               - Issue: reference/gitea/issue/issue.md

python_gitea-0.4.0/src/gitea/repository/__init__.py

@@ -0,0 +1,8 @@
+"""Repository package."""
+
+from __future__ import annotations
+
+from gitea.repository.async_repository import AsyncRepository
+from gitea.repository.repository import Repository
+
+__all__ = ["AsyncRepository", "Repository"]

python_gitea-0.4.0/src/gitea/repository/async_repository.py

@@ -0,0 +1,75 @@
+"""Asynchronous Gitea Repository resource."""
+
+from __future__ import annotations
+
+from typing import Any, cast
+
+from aiohttp import ClientResponse
+
+from gitea.repository.base import BaseRepository
+from gitea.resource.async_resource import AsyncResource
+from gitea.utils.response import process_async_response
+
+
+class AsyncRepository(AsyncResource, BaseRepository):
+    """Asynchronous Gitea Repository resource."""
+
+    async def _list_repositories(
+        self,
+        username: str | None = None,
+        organization: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> ClientResponse:
+        """List repositories for a user, organization, or authenticated user.
+
+        Args:
+            username: The username to list repositories for.
+            organization: The organization to list repositories for.
+            page: The page number for pagination.
+            limit: The number of repositories per page.
+            **kwargs: Additional arguments to pass to the request.
+
+        Returns:
+            The response object containing the list of repositories.
+
+        """
+        endpoint, params = self._list_repositories_helper(
+            username=username,
+            organization=organization,
+            page=page,
+            limit=limit,
+        )
+        return await self._get(endpoint=endpoint, params=params, **kwargs)
+
+    async def list_repositories(
+        self,
+        username: str | None = None,
+        organization: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> tuple[list[dict[str, Any]], int]:
+        """List repositories for a user, organization, or authenticated user.
+
+        Args:
+            username: The username to list repositories for.
+            organization: The organization to list repositories for.
+            page: The page number for pagination.
+            limit: The number of repositories per page.
+            **kwargs: Additional arguments to pass to the request.
+
+        Returns:
+            A tuple containing a list of repositories and the status code.
+
+        """
+        response = await self._list_repositories(
+            username=username,
+            organization=organization,
+            page=page,
+            limit=limit,
+            **kwargs,
+        )
+        data, status_code = await process_async_response(response=response)
+        return cast(list[dict[str, Any]], data), status_code

python_gitea-0.4.0/src/gitea/repository/base.py

@@ -0,0 +1,59 @@
+"""Base class for Gitea Repository resource."""
+
+from __future__ import annotations
+
+from typing import Any
+
+
+class BaseRepository:
+    """Base class for Gitea Repository resource."""
+
+    def _list_repositories_endpoint(self, username: str | None = None, organization: str | None = None) -> str:
+        """Construct the endpoint URL for listing repositories.
+
+        If both username and organization are None, it lists repositories for the authenticated user.
+        If username is provided, it lists repositories for that user.
+        If organization is provided, it lists repositories for that organization.
+
+        Args:
+            username: The username to list repositories for.
+            organization: The organization to list repositories for.
+
+        Returns:
+            The endpoint URL for listing repositories.
+
+        """
+        if username is None and organization is None:
+            return "/user/repos"
+        if username is not None and organization is None:
+            return f"/users/{username}/repos"
+        if username is None and organization is not None:
+            return f"/orgs/{organization}/repos"
+        raise ValueError("Either username or organization must be provided, not both.")
+
+    def _list_repositories_helper(
+        self,
+        username: str | None = None,
+        organization: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+    ) -> tuple[str, dict[str, Any]]:
+        """Get the endpoint and parameters for listing repositories.
+
+        Args:
+            username: The username to list repositories for.
+            organization: The organization to list repositories for.
+            page: The page number for pagination.
+            limit: The number of repositories per page.
+
+        Returns:
+            A tuple containing the endpoint URL and a dictionary of parameters.
+
+        """
+        endpoint = self._list_repositories_endpoint(username=username, organization=organization)
+        params = {}
+        if page is not None:
+            params["page"] = page
+        if limit is not None:
+            params["limit"] = limit
+        return endpoint, params

python_gitea-0.4.0/src/gitea/repository/repository.py

@@ -0,0 +1,75 @@
+"""Gitea Repository resource."""
+
+from __future__ import annotations
+
+from typing import Any, cast
+
+from requests import Response
+
+from gitea.repository.base import BaseRepository
+from gitea.resource.resource import Resource
+from gitea.utils.response import process_response
+
+
+class Repository(Resource, BaseRepository):
+    """Gitea Repository resource."""
+
+    def _list_repositories(
+        self,
+        username: str | None = None,
+        organization: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> Response:
+        """List repositories for a user, organization, or authenticated user.
+
+        Args:
+            username: The username to list repositories for.
+            organization: The organization to list repositories for.
+            page: The page number for pagination.
+            limit: The number of repositories per page.
+            **kwargs: Additional arguments to pass to the request.
+
+        Returns:
+            The response object containing the list of repositories.
+
+        """
+        endpoint, params = self._list_repositories_helper(
+            username=username,
+            organization=organization,
+            page=page,
+            limit=limit,
+        )
+        return self._get(endpoint=endpoint, params=params, **kwargs)
+
+    def list_repositories(
+        self,
+        username: str | None = None,
+        organization: str | None = None,
+        page: int | None = None,
+        limit: int | None = None,
+        **kwargs: Any,
+    ) -> tuple[list[dict[str, Any]], int]:
+        """List repositories for a user, organization, or authenticated user.
+
+        Args:
+            username: The username to list repositories for.
+            organization: The organization to list repositories for.
+            page: The page number for pagination.
+            limit: The number of repositories per page.
+            **kwargs: Additional arguments to pass to the request.
+
+        Returns:
+            A tuple containing a list of repositories and the status code.
+
+        """
+        response = self._list_repositories(
+            username=username,
+            organization=organization,
+            page=page,
+            limit=limit,
+            **kwargs,
+        )
+        data, status_code = process_response(response=response)
+        return cast(list[dict[str, Any]], data), status_code

python_gitea-0.4.0/tests/repository/__init__.py

@@ -0,0 +1 @@
+"""Unit tests for repository package."""

python_gitea-0.4.0/tests/repository/test_repository_async_repository.py

@@ -0,0 +1,128 @@
+"""Unit tests for the AsyncRepository class."""
+
+from unittest.mock import AsyncMock, MagicMock, patch
+
+import pytest
+
+from gitea.repository.async_repository import AsyncRepository
+
+
+class TestAsyncRepository:
+    """Test cases for the AsyncRepository class."""
+
+    @pytest.fixture
+    def mock_client(self):
+        """Fixture to create a mock AsyncGitea client."""
+        client = MagicMock()
+        mock_response = MagicMock()
+        mock_response.json = AsyncMock(return_value=[{"id": 1, "name": "repo1"}])
+        mock_response.status = 200
+        client._request = AsyncMock(return_value=mock_response)
+        return client
+
+    @pytest.fixture
+    def async_repository(self, mock_client):
+        """Fixture to create an AsyncRepository instance."""
+        return AsyncRepository(client=mock_client)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_authenticated(self, async_repository, mock_client):
+        """Test list_repositories for authenticated user."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ([{"id": 1, "name": "repo1"}], 200)
+            result = await async_repository.list_repositories()
+            mock_client._request.assert_called_once_with(method="GET", endpoint="/user/repos", params={})
+            assert result == ([{"id": 1, "name": "repo1"}], 200)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_by_username(self, async_repository, mock_client):
+        """Test list_repositories for a specific user."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ([{"id": 2, "name": "other_repo"}], 200)
+            result = await async_repository.list_repositories(username="testuser")
+            mock_client._request.assert_called_once_with(method="GET", endpoint="/users/testuser/repos", params={})
+            assert result == ([{"id": 2, "name": "other_repo"}], 200)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_by_organization(self, async_repository, mock_client):
+        """Test list_repositories for a specific organization."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = (
+                [{"id": 3, "name": "org_repo1"}, {"id": 4, "name": "org_repo2"}],
+                200,
+            )
+            result = await async_repository.list_repositories(organization="test_org")
+            mock_client._request.assert_called_once_with(method="GET", endpoint="/orgs/test_org/repos", params={})
+            assert result == (
+                [{"id": 3, "name": "org_repo1"}, {"id": 4, "name": "org_repo2"}],
+                200,
+            )
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_with_pagination(self, async_repository, mock_client):
+        """Test list_repositories with pagination parameters."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ([{"id": 1, "name": "repo1"}], 200)
+            result = await async_repository.list_repositories(page=2, limit=50)
+            mock_client._request.assert_called_once_with(
+                method="GET", endpoint="/user/repos", params={"page": 2, "limit": 50}
+            )
+            assert result == ([{"id": 1, "name": "repo1"}], 200)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_by_username_with_pagination(self, async_repository, mock_client):
+        """Test list_repositories for a user with pagination."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ([{"id": 5, "name": "paginated_repo"}], 200)
+            result = await async_repository.list_repositories(username="testuser", page=1, limit=25)
+            mock_client._request.assert_called_once_with(
+                method="GET",
+                endpoint="/users/testuser/repos",
+                params={"page": 1, "limit": 25},
+            )
+            assert result == ([{"id": 5, "name": "paginated_repo"}], 200)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_by_organization_with_pagination(self, async_repository, mock_client):
+        """Test list_repositories for an organization with pagination."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = (
+                [{"id": 6, "name": "org_paginated_repo"}],
+                200,
+            )
+            result = await async_repository.list_repositories(organization="test_org", page=3, limit=100)
+            mock_client._request.assert_called_once_with(
+                method="GET",
+                endpoint="/orgs/test_org/repos",
+                params={"page": 3, "limit": 100},
+            )
+            assert result == ([{"id": 6, "name": "org_paginated_repo"}], 200)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_empty_result(self, async_repository, mock_client):
+        """Test list_repositories with empty result."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ([], 200)
+            result = await async_repository.list_repositories()
+            mock_client._request.assert_called_once()
+            assert result == ([], 200)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_error_response(self, async_repository, mock_client):
+        """Test list_repositories with error response."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ({"error": "Not Found"}, 404)
+            result = await async_repository.list_repositories(username="nonexistent")
+            mock_client._request.assert_called_once()
+            assert result == ({"error": "Not Found"}, 404)
+
+    @pytest.mark.asyncio
+    async def test_list_repositories_with_kwargs(self, async_repository, mock_client):
+        """Test list_repositories passing additional kwargs to _get method."""
+        with patch("gitea.repository.async_repository.process_async_response") as mock_process:
+            mock_process.return_value = ([{"id": 1, "name": "repo1"}], 200)
+            result = await async_repository.list_repositories(headers={"Custom": "Header"})
+            mock_client._request.assert_called_once_with(
+                method="GET", endpoint="/user/repos", params={}, headers={"Custom": "Header"}
+            )
+            assert result == ([{"id": 1, "name": "repo1"}], 200)

python_gitea-0.4.0/tests/repository/test_repository_base.py

@@ -0,0 +1,91 @@
+"""Unit tests for the BaseRepository class."""
+
+import pytest
+
+from gitea.repository.base import BaseRepository
+
+
+class TestBaseRepository:
+    """Test cases for the BaseRepository base class."""
+
+    def test_list_repositories_endpoint_authenticated(self):
+        """Test _list_repositories_endpoint for authenticated user."""
+        base_repo = BaseRepository()
+        endpoint = base_repo._list_repositories_endpoint(username=None, organization=None)
+        assert endpoint == "/user/repos"
+
+    def test_list_repositories_endpoint_by_username(self):
+        """Test _list_repositories_endpoint for a specific user."""
+        base_repo = BaseRepository()
+        endpoint = base_repo._list_repositories_endpoint(username="testuser", organization=None)
+        assert endpoint == "/users/testuser/repos"
+
+    def test_list_repositories_endpoint_by_organization(self):
+        """Test _list_repositories_endpoint for a specific organization."""
+        base_repo = BaseRepository()
+        endpoint = base_repo._list_repositories_endpoint(username=None, organization="test_org")
+        assert endpoint == "/orgs/test_org/repos"
+
+    def test_list_repositories_endpoint_both_raises_error(self):
+        """Test _list_repositories_endpoint raises error when both username and organization are provided."""
+        base_repo = BaseRepository()
+        with pytest.raises(ValueError, match=r"Either username or organization must be provided, not both."):
+            base_repo._list_repositories_endpoint(username="testuser", organization="test_org")
+
+    def test_list_repositories_helper_authenticated(self):
+        """Test _list_repositories_helper for authenticated user."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username=None, organization=None)
+        assert endpoint == "/user/repos"
+        assert params == {}
+
+    def test_list_repositories_helper_with_pagination(self):
+        """Test _list_repositories_helper with pagination parameters."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username=None, organization=None, page=2, limit=50)
+        assert endpoint == "/user/repos"
+        assert params == {"page": 2, "limit": 50}
+
+    def test_list_repositories_helper_by_username(self):
+        """Test _list_repositories_helper for a specific user."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username="testuser", organization=None)
+        assert endpoint == "/users/testuser/repos"
+        assert params == {}
+
+    def test_list_repositories_helper_by_username_with_pagination(self):
+        """Test _list_repositories_helper for a specific user with pagination."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username="testuser", organization=None, page=1, limit=20)
+        assert endpoint == "/users/testuser/repos"
+        assert params == {"page": 1, "limit": 20}
+
+    def test_list_repositories_helper_by_organization(self):
+        """Test _list_repositories_helper for a specific organization."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username=None, organization="test_org")
+        assert endpoint == "/orgs/test_org/repos"
+        assert params == {}
+
+    def test_list_repositories_helper_by_organization_with_pagination(self):
+        """Test _list_repositories_helper for a specific organization with pagination."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(
+            username=None, organization="test_org", page=3, limit=100
+        )
+        assert endpoint == "/orgs/test_org/repos"
+        assert params == {"page": 3, "limit": 100}
+
+    def test_list_repositories_helper_page_only(self):
+        """Test _list_repositories_helper with only page parameter."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username=None, organization=None, page=5)
+        assert endpoint == "/user/repos"
+        assert params == {"page": 5}
+
+    def test_list_repositories_helper_limit_only(self):
+        """Test _list_repositories_helper with only limit parameter."""
+        base_repo = BaseRepository()
+        endpoint, params = base_repo._list_repositories_helper(username=None, organization=None, limit=75)
+        assert endpoint == "/user/repos"
+        assert params == {"limit": 75}

python_gitea-0.4.0/tests/repository/test_repository_repository.py

@@ -0,0 +1,119 @@
+"""Unit tests for the Repository class."""
+
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from gitea.repository.repository import Repository
+
+
+class TestRepository:
+    """Test cases for the Repository class."""
+
+    @pytest.fixture
+    def mock_client(self):
+        """Fixture to create a mock Gitea client."""
+        client = MagicMock()
+        mock_response = MagicMock()
+        mock_response.json.return_value = [{"id": 1, "name": "repo1"}]
+        mock_response.status_code = 200
+        client._request.return_value = mock_response
+        return client
+
+    @pytest.fixture
+    def repository(self, mock_client):
+        """Fixture to create a Repository instance."""
+        return Repository(client=mock_client)
+
+    def test_list_repositories_authenticated(self, repository, mock_client):
+        """Test list_repositories for authenticated user."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ([{"id": 1, "name": "repo1"}], 200)
+            result = repository.list_repositories()
+            mock_client._request.assert_called_once_with(method="GET", endpoint="/user/repos", params={})
+            assert result == ([{"id": 1, "name": "repo1"}], 200)
+
+    def test_list_repositories_by_username(self, repository, mock_client):
+        """Test list_repositories for a specific user."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ([{"id": 2, "name": "other_repo"}], 200)
+            result = repository.list_repositories(username="testuser")
+            mock_client._request.assert_called_once_with(method="GET", endpoint="/users/testuser/repos", params={})
+            assert result == ([{"id": 2, "name": "other_repo"}], 200)
+
+    def test_list_repositories_by_organization(self, repository, mock_client):
+        """Test list_repositories for a specific organization."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = (
+                [{"id": 3, "name": "org_repo1"}, {"id": 4, "name": "org_repo2"}],
+                200,
+            )
+            result = repository.list_repositories(organization="test_org")
+            mock_client._request.assert_called_once_with(method="GET", endpoint="/orgs/test_org/repos", params={})
+            assert result == (
+                [{"id": 3, "name": "org_repo1"}, {"id": 4, "name": "org_repo2"}],
+                200,
+            )
+
+    def test_list_repositories_with_pagination(self, repository, mock_client):
+        """Test list_repositories with pagination parameters."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ([{"id": 1, "name": "repo1"}], 200)
+            result = repository.list_repositories(page=2, limit=50)
+            mock_client._request.assert_called_once_with(
+                method="GET", endpoint="/user/repos", params={"page": 2, "limit": 50}
+            )
+            assert result == ([{"id": 1, "name": "repo1"}], 200)
+
+    def test_list_repositories_by_username_with_pagination(self, repository, mock_client):
+        """Test list_repositories for a user with pagination."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ([{"id": 5, "name": "paginated_repo"}], 200)
+            result = repository.list_repositories(username="testuser", page=1, limit=25)
+            mock_client._request.assert_called_once_with(
+                method="GET",
+                endpoint="/users/testuser/repos",
+                params={"page": 1, "limit": 25},
+            )
+            assert result == ([{"id": 5, "name": "paginated_repo"}], 200)
+
+    def test_list_repositories_by_organization_with_pagination(self, repository, mock_client):
+        """Test list_repositories for an organization with pagination."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = (
+                [{"id": 6, "name": "org_paginated_repo"}],
+                200,
+            )
+            result = repository.list_repositories(organization="test_org", page=3, limit=100)
+            mock_client._request.assert_called_once_with(
+                method="GET",
+                endpoint="/orgs/test_org/repos",
+                params={"page": 3, "limit": 100},
+            )
+            assert result == ([{"id": 6, "name": "org_paginated_repo"}], 200)
+
+    def test_list_repositories_empty_result(self, repository, mock_client):
+        """Test list_repositories with empty result."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ([], 200)
+            result = repository.list_repositories()
+            mock_client._request.assert_called_once()
+            assert result == ([], 200)
+
+    def test_list_repositories_error_response(self, repository, mock_client):
+        """Test list_repositories with error response."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ({"error": "Not Found"}, 404)
+            result = repository.list_repositories(username="nonexistent")
+            mock_client._request.assert_called_once()
+            assert result == ({"error": "Not Found"}, 404)
+
+    def test_list_repositories_with_kwargs(self, repository, mock_client):
+        """Test list_repositories passing additional kwargs to _get method."""
+        with patch("gitea.repository.repository.process_response") as mock_process:
+            mock_process.return_value = ([{"id": 1, "name": "repo1"}], 200)
+            result = repository.list_repositories(headers={"Custom": "Header"})
+            mock_client._request.assert_called_once_with(
+                method="GET", endpoint="/user/repos", params={}, headers={"Custom": "Header"}
+            )
+            assert result == ([{"id": 1, "name": "repo1"}], 200)