fix(client): regression - do not automatically get_next if page=# and

Helen Koike · JohnVillalovos · commit 585e3a86c4ca · 2023-01-25T09:18:48.000-08:00
iterator=True/as_list=False are used This fix a regression introduced on commit 1339d64 If page is used, then get_next should be false. This was found on the mesa ci project, after upgrading the python-gitlab version, the script that monitors the ci was getting killed by consuming too much memory.
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -393,6 +393,9 @@ The generator exposes extra listing information as received from the server:
    Prior to python-gitlab 3.6.0 the argument ``as_list`` was used instead of
    ``iterator``.  ``as_list=False`` is the equivalent of ``iterator=True``.
 
+.. note::
+   If ``page`` and ``iterator=True`` are used together, the latter is ignored.
+
 Sudo
 ====
 
diff --git a/gitlab/client.py b/gitlab/client.py
@@ -929,7 +929,7 @@ def http_list(
 
         page = kwargs.get("page")
 
-        if iterator:
+        if iterator and page is None:
             # Generator requested
             return GitlabList(self, url, query_data, **kwargs)
 
diff --git a/tests/unit/test_gitlab_http_methods.py b/tests/unit/test_gitlab_http_methods.py
@@ -542,6 +542,18 @@ def test_list_request(gl):
     assert responses.assert_call_count(url, 3) is True
 
 
+@responses.activate
+def test_list_request_page_and_iterator(gl):
+    response_dict = copy.deepcopy(large_list_response)
+    response_dict["match"] = [responses.matchers.query_param_matcher({"page": "1"})]
+    responses.add(**response_dict)
+
+    result = gl.http_list("/projects", iterator=True, page=1)
+    assert isinstance(result, list)
+    assert len(result) == 20
+    assert len(responses.calls) == 1
+
+
 large_list_response = {
     "method": responses.GET,
     "url": "http://localhost/api/v4/projects",
