Skip to content

Commit 9aa7a66

Browse files
JohnVillalovosJohnVillalovos
committed
feat: emit a warning when using a list() method returns max
A common cause of issues filed and questions raised is that a user will call a `list()` method and only get 20 items. As this is the default maximum of items that will be returned from a `list()` method. To help with this we now emit a warning when the result from a `list()` method is greater-than or equal to 20 (or the specified `per_page` value) and the user is not using either `all=True`, `all=False`, `as_list=False`, or `page=X`.
1 parent e85de1e commit 9aa7a66

File tree

5 files changed

+191
-12
lines changed

5 files changed

+191
-12
lines changed

‎docs/api-usage.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,20 +93,26 @@ Examples:
9393
.. code-block:: python
9494
9595
# list all the projects
96-
projects = gl.projects.list()
96+
projects = gl.projects.list(as_list=False)
9797
for project in projects:
9898
print(project)
9999
100100
# get the group with id == 2
101101
group = gl.groups.get(2)
102-
for project in group.projects.list():
102+
for project in group.projects.list(as_list=False):
103103
print(project)
104104
105105
# create a new user
106106
user_data = {'email': 'jen@foo.com', 'username': 'jen', 'name': 'Jen'}
107107
user = gl.users.create(user_data)
108108
print(user)
109109
110+
.. warning::
111+
Calling `list()` without any arguments will by default not return the complete list
112+
of items. Use either the `all=True` or `as_list=False` parameters to get all the
113+
items when using listing methods. See the :ref:`pagination` section for more
114+
information.
115+
110116
You can list the mandatory and optional attributes for object creation and
111117
update with the manager's ``get_create_attrs()`` and ``get_update_attrs()``
112118
methods. They return 2 tuples, the first one is the list of mandatory
@@ -133,7 +139,7 @@ Some objects also provide managers to access related GitLab resources:
133139
134140
# list the issues for a project
135141
project = gl.projects.get(1)
136-
issues = project.issues.list()
142+
issues = project.issues.list(all=True)
137143
138144
python-gitlab allows to send any data to the GitLab server when making queries.
139145
In case of invalid or missing arguments python-gitlab will raise an exception
@@ -150,9 +156,9 @@ conflict with python or python-gitlab when using them as kwargs:
150156

151157
.. code-block:: python
152158
153-
gl.user_activities.list(from='2019-01-01') ## invalid
159+
gl.user_activities.list(from='2019-01-01', as_list=False) ## invalid
154160
155-
gl.user_activities.list(query_parameters={'from': '2019-01-01'}) # OK
161+
gl.user_activities.list(query_parameters={'from': '2019-01-01'}, as_list=False) # OK
156162
157163
Gitlab Objects
158164
==============
@@ -222,6 +228,8 @@ a project (the previous example used 2 API calls):
222228
project = gl.projects.get(1, lazy=True) # no API call
223229
project.star() # API call
224230
231+
.. _pagination:
232+
225233
Pagination
226234
==========
227235

‎gitlab/client.py

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
import requests.utils
2525
from requests_toolbelt.multipart.encoder import MultipartEncoder # type: ignore
2626

27+
import gitlab
2728
import gitlab.config
2829
import gitlab.const
2930
import gitlab.exceptions
@@ -35,6 +36,12 @@
3536
"{source!r} to {target!r}"
3637
)
3738

39+
# https://docs.gitlab.com/ee/api/#offset-based-pagination
40+
_PAGINATION_URL = (
41+
f"https://python-gitlab.readthedocs.io/en/v{gitlab.__version__}/"
42+
f"api-usage.html#pagination"
43+
)
44+
3845

3946
class Gitlab:
4047
"""Represents a GitLab server connection.
@@ -808,7 +815,7 @@ def http_list(
808815
# In case we want to change the default behavior at some point
809816
as_list = True if as_list is None else as_list
810817

811-
get_all = kwargs.pop("all", False)
818+
get_all = kwargs.pop("all", None)
812819
url = self._build_url(path)
813820

814821
page = kwargs.get("page")
@@ -818,7 +825,28 @@ def http_list(
818825

819826
if page or as_list is True:
820827
# pagination requested, we return a list
821-
return list(GitlabList(self, url, query_data, get_next=False, **kwargs))
828+
gl_list = GitlabList(self, url, query_data, get_next=False, **kwargs)
829+
items = list(gl_list)
830+
if page is None and get_all is None and gl_list.per_page is not None:
831+
if len(items) >= gl_list.per_page and (
832+
gl_list.total is None or len(items) < gl_list.total
833+
):
834+
total_items = "10,000+" if gl_list.total is None else gl_list.total
835+
# Warn the user that they are only going to retrieve `per_page`
836+
# maximum items. This is a common cause of issues filed.
837+
utils.warn(
838+
message=(
839+
f"Calling a `list()` method without specifying `all=True` "
840+
f"or `as_list=False` will return a maximum of "
841+
f"{gl_list.per_page} items. Your query returned "
842+
f"{len(items)} of {total_items} items. See "
843+
f"{_PAGINATION_URL} for more details. If this was done "
844+
f"intentionally, then this warning can be supressed by "
845+
f"adding the argument `all=False` to the `list()` call."
846+
),
847+
category=UserWarning,
848+
)
849+
return items
822850

823851
# No pagination, generator requested
824852
return GitlabList(self, url, query_data, **kwargs)

‎tests/functional/api/test_gitlab.py

Lines changed: 47 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
import warnings
2+
13
import pytest
24

35
import gitlab
@@ -81,13 +83,13 @@ def test_template_dockerfile(gl):
8183

8284

8385
def test_template_gitignore(gl):
84-
assert gl.gitignores.list()
86+
assert gl.gitignores.list(all=True)
8587
gitignore = gl.gitignores.get("Node")
8688
assert gitignore.content is not None
8789

8890

8991
def test_template_gitlabciyml(gl):
90-
assert gl.gitlabciymls.list()
92+
assert gl.gitlabciymls.list(all=True)
9193
gitlabciyml = gl.gitlabciymls.get("Nodejs")
9294
assert gitlabciyml.content is not None
9395

@@ -181,3 +183,46 @@ def test_rate_limits(gl):
181183
settings.throttle_authenticated_api_enabled = False
182184
settings.save()
183185
[project.delete() for project in projects]
186+
187+
188+
def test_list_default_warning(gl):
189+
"""When there are more than 20 items and use default `list()` then warning is
190+
generated"""
191+
with warnings.catch_warnings(record=True) as caught_warnings:
192+
gl.gitlabciymls.list()
193+
assert len(caught_warnings) == 1
194+
warning = caught_warnings[0]
195+
assert isinstance(warning.message, UserWarning)
196+
message = str(warning.message)
197+
assert "python-gitlab.readthedocs.io" in message
198+
assert __file__ == warning.filename
199+
200+
201+
def test_list_page_nowarning(gl):
202+
"""Using `page=X` will disable the warning"""
203+
with warnings.catch_warnings(record=True) as caught_warnings:
204+
gl.gitlabciymls.list(page=1)
205+
assert len(caught_warnings) == 0
206+
207+
208+
def test_list_all_false_nowarning(gl):
209+
"""Using `all=False` will disable the warning"""
210+
with warnings.catch_warnings(record=True) as caught_warnings:
211+
gl.gitlabciymls.list(all=False)
212+
assert len(caught_warnings) == 0
213+
214+
215+
def test_list_all_true_nowarning(gl):
216+
"""Using `all=True` will disable the warning"""
217+
with warnings.catch_warnings(record=True) as caught_warnings:
218+
items = gl.gitlabciymls.list(all=True)
219+
assert len(caught_warnings) == 0
220+
assert len(items) > 20
221+
222+
223+
def test_list_as_list_false_nowarning(gl):
224+
"""Using `as_list=False` will disable the warning"""
225+
with warnings.catch_warnings(record=True) as caught_warnings:
226+
items = gl.gitlabciymls.list(as_list=False)
227+
assert len(caught_warnings) == 0
228+
assert len(list(items)) > 20

‎tests/functional/fixtures/docker-compose.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ services:
1414
GITLAB_ROOT_PASSWORD: 5iveL!fe
1515
GITLAB_SHARED_RUNNERS_REGISTRATION_TOKEN: registration-token
1616
GITLAB_OMNIBUS_CONFIG: |
17-
external_url 'http://127.0.0.1:8080'
17+
external_url 'http://localhost:8080'
1818
registry['enable'] = false
1919
nginx['redirect_http_to_https'] = false
2020
nginx['listen_port'] = 80

‎tests/unit/test_gitlab_http_methods.py

Lines changed: 100 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
import copy
2+
import warnings
3+
14
import pytest
25
import requests
36
import responses
@@ -329,20 +332,115 @@ def test_list_request(gl):
329332
match=MATCH_EMPTY_QUERY_PARAMS,
330333
)
331334

332-
result = gl.http_list("/projects", as_list=True)
335+
with warnings.catch_warnings(record=True) as caught_warnings:
336+
result = gl.http_list("/projects", as_list=True)
337+
assert len(caught_warnings) == 0
333338
assert isinstance(result, list)
334339
assert len(result) == 1
335340

336341
result = gl.http_list("/projects", as_list=False)
337342
assert isinstance(result, GitlabList)
338-
assert len(result) == 1
343+
assert len(list(result)) == 1
339344

340345
result = gl.http_list("/projects", all=True)
341346
assert isinstance(result, list)
342347
assert len(result) == 1
343348
assert responses.assert_call_count(url, 3) is True
344349

345350

351+
large_list_response = {
352+
"method": responses.GET,
353+
"url": "http://localhost/api/v4/projects",
354+
"json": [
355+
{"name": "project01"},
356+
{"name": "project02"},
357+
{"name": "project03"},
358+
{"name": "project04"},
359+
{"name": "project05"},
360+
{"name": "project06"},
361+
{"name": "project07"},
362+
{"name": "project08"},
363+
{"name": "project09"},
364+
{"name": "project10"},
365+
{"name": "project11"},
366+
{"name": "project12"},
367+
{"name": "project13"},
368+
{"name": "project14"},
369+
{"name": "project15"},
370+
{"name": "project16"},
371+
{"name": "project17"},
372+
{"name": "project18"},
373+
{"name": "project19"},
374+
{"name": "project20"},
375+
],
376+
"headers": {"X-Total": "30", "x-per-page": "20"},
377+
"status": 200,
378+
"match": MATCH_EMPTY_QUERY_PARAMS,
379+
}
380+
381+
382+
@responses.activate
383+
def test_list_request_pagination_warning(gl):
384+
responses.add(**large_list_response)
385+
386+
with warnings.catch_warnings(record=True) as caught_warnings:
387+
result = gl.http_list("/projects", as_list=True)
388+
assert len(caught_warnings) == 1
389+
warning = caught_warnings[0]
390+
assert isinstance(warning.message, UserWarning)
391+
message = str(warning.message)
392+
assert "Calling a `list()` method" in message
393+
assert "python-gitlab.readthedocs.io" in message
394+
assert __file__ == warning.filename
395+
assert isinstance(result, list)
396+
assert len(result) == 20
397+
assert len(responses.calls) == 1
398+
399+
400+
@responses.activate
401+
def test_list_request_as_list_false_nowarning(gl):
402+
responses.add(**large_list_response)
403+
with warnings.catch_warnings(record=True) as caught_warnings:
404+
result = gl.http_list("/projects", as_list=False)
405+
assert len(caught_warnings) == 0
406+
assert isinstance(result, GitlabList)
407+
assert len(list(result)) == 20
408+
assert len(responses.calls) == 1
409+
410+
411+
@responses.activate
412+
def test_list_request_all_true_nowarning(gl):
413+
responses.add(**large_list_response)
414+
with warnings.catch_warnings(record=True) as caught_warnings:
415+
result = gl.http_list("/projects", all=True)
416+
assert len(caught_warnings) == 0
417+
assert isinstance(result, list)
418+
assert len(result) == 20
419+
assert len(responses.calls) == 1
420+
421+
422+
@responses.activate
423+
def test_list_request_all_false_nowarning(gl):
424+
responses.add(**large_list_response)
425+
with warnings.catch_warnings(record=True) as caught_warnings:
426+
result = gl.http_list("/projects", all=False)
427+
assert len(caught_warnings) == 0
428+
assert isinstance(result, list)
429+
assert len(result) == 20
430+
assert len(responses.calls) == 1
431+
432+
433+
@responses.activate
434+
def test_list_request_page_nowarning(gl):
435+
response_dict = copy.deepcopy(large_list_response)
436+
response_dict["match"] = [responses.matchers.query_param_matcher({"page": "1"})]
437+
responses.add(**response_dict)
438+
with warnings.catch_warnings(record=True) as caught_warnings:
439+
gl.http_list("/projects", page=1)
440+
assert len(caught_warnings) == 0
441+
assert len(responses.calls) == 1
442+
443+
346444
@responses.activate
347445
def test_list_request_404(gl):
348446
url = "http://localhost/api/v4/not_there"

0 commit comments

Comments
 (0)