Merge pull request #1003 from python-gitlab/feat/all-keyset-pagination

bufferoverflow · web-flow · commit 3aa9873c8e5f · 2020-02-25T12:31:32.000+01:00
feat: use keyset pagination by default for `all=True`
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -204,6 +204,11 @@ listing methods support the ``page`` and ``per_page`` parameters:
 By default GitLab does not return the complete list of items. Use the ``all``
 parameter to get all the items when using listing methods:
 
+.. warning::
+
+   The all=True option uses keyset pagination by default if order_by is not supplied,
+   or if order_by="id".
+
 .. code-block:: python
 
    all_groups = gl.groups.list(all=True)
@@ -391,4 +396,3 @@ parameter to that API invocation:
 
    gl = gitlab.gitlab(url, token, api_version=4)
    gl.projects.import_github(ACCESS_TOKEN, 123456, "root", timeout=120.0)
-
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -640,6 +640,12 @@ def http_list(self, path, query_data=None, as_list=None, **kwargs):
         get_all = kwargs.pop("all", False)
         url = self._build_url(path)
 
+        # use keyset pagination automatically, if all=True
+        order_by = kwargs.get("order_by")
+        if get_all and (not order_by or order_by == "id"):
+            kwargs["pagination"] = "keyset"
+            kwargs["order_by"] = "id"
+
         if get_all is True and as_list is True:
             return list(GitlabList(self, url, query_data, **kwargs))
 
