Merge pull request openSUSE#1977 from openSUSE/bug/pull_limit-1

Use pagination instead of limit -1 when working with Gitea API

Author: dmach

osc/gitea_api/branch.py

@@ -1,16 +1,13 @@
 from typing import List
 from typing import Optional
 
+from .common import GiteaModel
 from .connection import Connection
 from .connection import GiteaHTTPResponse
 from .exceptions import BranchExists
 
 
-class Branch:
-    def __init__(self, data: dict, *, response: Optional[GiteaHTTPResponse] = None):
-        self._data = data
-        self._response = response
-
+class Branch(GiteaModel):
     @property
     def commit(self) -> str:
         return self._data["commit"]["id"]
@@ -55,13 +52,13 @@ def list(
         :param repo: Name of the repo.
         """
         q = {
-            "limit": -1,
+            "limit": 50,
         }
         url = conn.makeurl("repos", owner, repo, "branches", query=q)
         # XXX: returns 'null' when there are no branches; an empty list would be a better API
-        response = conn.request("GET", url)
-        obj_list = [cls(i, response=response) for i in response.json() or []]
-        return obj_list
+        obj_list = []
+        for response in conn.request_all_pages("GET", url):
+            obj_list.extend([cls(i, response=response, conn=conn) for i in response.json() or []])
 
     @classmethod
     def create(

osc/gitea_api/fork.py

@@ -1,12 +1,13 @@
 from typing import List
 from typing import Optional
 
+from .common import GiteaModel
 from .connection import Connection
 from .exceptions import ForkExists
 from .repo import Repo
 
 
-class Fork:
+class Fork(GiteaModel):
     @classmethod
     def list(
         cls,
@@ -22,11 +23,12 @@ def list(
         :param repo: Name of the repo.
         """
         q = {
-            "limit": -1,
+            "limit": 50,
         }
         url = conn.makeurl("repos", owner, repo, "forks", query=q)
-        response = conn.request("GET", url)
-        obj_list = [Repo(i, response=response) for i in response.json()]
+        obj_list = []
+        for response in conn.request_all_pages("GET", url):
+            obj_list.extend([Repo(i, response=response, conn=conn) for i in response.json()])
         return obj_list
 
     @classmethod

osc/gitea_api/issue_timeline_entry.py

@@ -265,9 +265,10 @@ def list(
         :param number: Number of the pull request in owner/repo.
         """
         q = {
-            "limit": -1,
+            "limit": 50,
         }
         url = conn.makeurl("repos", owner, repo, "issues", str(number), "timeline", query=q)
-        response = conn.request("GET", url)
-        obj_list = [cls(i, response=response, conn=conn, check_data=False) for i in response.json() or []]
+        obj_list = []
+        for response in conn.request_all_pages("GET", url):
+            obj_list.extend([cls(i, response=response, conn=conn) for i in response.json() or []])
         return obj_list

osc/gitea_api/pr.py

@@ -1,5 +1,6 @@
 import functools
 import re
+import typing
 from typing import Dict
 from typing import List
 from typing import Optional
@@ -10,63 +11,8 @@
 from .connection import GiteaHTTPResponse
 from .user import User
 
-
-class PullRequestReview(GiteaModel):
-    @property
-    def state(self) -> str:
-        return self._data["state"]
-
-    @property
-    def user(self) -> Optional[str]:
-        if not self._data["user"]:
-            return None
-        return self._data["user"]["login"]
-
-    @property
-    def team(self) -> Optional[str]:
-        if not self._data["team"]:
-            return None
-        return self._data["team"]["name"]
-
-    @property
-    def who(self) -> str:
-        return self.user if self.user else f"@{self.team}"
-
-    @property
-    def submitted_at(self) -> str:
-        return self._data["submitted_at"]
-
-    @property
-    def updated_at(self) -> str:
-        return self._data["updated_at"]
-
-    @property
-    def body(self) -> str:
-        return self._data["body"]
-
-    @classmethod
-    def list(
-        cls,
-        conn: Connection,
-        owner: str,
-        repo: str,
-        number: int,
-    ) -> List["PullRequestReview"]:
-        """
-        List reviews associated with a pull request.
-
-        :param conn: Gitea ``Connection`` instance.
-        :param owner: Owner of the repo.
-        :param repo: Name of the repo.
-        :param number: Number of the pull request in owner/repo.
-        """
-        q = {
-            "limit": -1,
-        }
-        url = conn.makeurl("repos", owner, repo, "pulls", str(number), "reviews", query=q)
-        response = conn.request("GET", url)
-        obj_list = [cls(i, response=response) for i in response.json()]
-        return obj_list
+if typing.TYPE_CHECKING:
+    from .pr_review import PullRequestReview
 
 
 @functools.total_ordering
@@ -448,11 +394,12 @@ def list(
 
         q = {
             "state": state,
-            "limit": -1,
+            "limit": 50,
         }
         url = conn.makeurl("repos", owner, repo, "pulls", query=q)
-        response = conn.request("GET", url)
-        obj_list = [cls(i, response=response, conn=conn) for i in response.json()]
+        obj_list = []
+        for response in conn.request_all_pages("GET", url):
+            obj_list.extend([cls(i, response=response, conn=conn) for i in response.json()])
         return obj_list
 
     @classmethod
@@ -544,7 +491,9 @@ def add_comment(
     def get_reviews(
         self,
         conn: Connection,
-    ) -> List[PullRequestReview]:
+    ) -> List["PullRequestReview"]:
+        from .pr_review import PullRequestReview
+
         return PullRequestReview.list(conn, self.base_owner, self.base_repo, self.number)
 
     @classmethod

osc/gitea_api/pr_review.py

@@ -127,9 +127,10 @@ def list(
         :param number: Number of the pull request in owner/repo.
         """
         q = {
-            "limit": -1,
+            "limit": 50,
         }
         url = conn.makeurl("repos", owner, repo, "pulls", str(number), "reviews", query=q)
-        response = conn.request("GET", url)
-        obj_list = [cls(i, response=response, conn=conn) for i in response.json()]
+        obj_list = []
+        for response in conn.request_all_pages("GET", url):
+            obj_list.extend([cls(i, response=response, conn=conn) for i in response.json()])
         return obj_list

osc/gitea_api/ssh_key.py

@@ -1,15 +1,12 @@
 from typing import List
 from typing import Optional
 
+from .common import GiteaModel
 from .connection import Connection
 from .connection import GiteaHTTPResponse
 
 
-class SSHKey:
-    def __init__(self, data: dict, *, response: Optional[GiteaHTTPResponse] = None):
-        self._data = data
-        self._response = response
-
+class SSHKey(GiteaModel):
     @property
     def id(self) -> int:
         return self._data["id"]
@@ -43,11 +40,13 @@ def list(cls, conn: Connection) -> List["SSHKey"]:
         :param conn: Gitea ``Connection`` instance.
         """
         q = {
-            "limit": -1,
+            "limit": 50,
         }
         url = conn.makeurl("user", "keys", query=q)
         response = conn.request("GET", url)
-        obj_list = [cls(i, response=response) for i in response.json()]
+        obj_list = []
+        for response in conn.request_all_pages("GET", url):
+            obj_list.extend([cls(i, response=response, conn=conn) for i in response.json() or []])
         return obj_list
 
     @classmethod