Commit3aa9873

authored

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

feat: use keyset pagination by default for `all=True`

2 parents745bdf7 +1609824 commit3aa9873Copy full SHA for 3aa9873

File tree

+11

-1

lines changed

+11

-1

lines changed

Lines changed: 5 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -204,6 +204,11 @@ listing methods support the ``page`` and ``per_page`` parameters:
`204`	`204`	By default GitLab does not return the complete list of items. Use the ``all``
`205`	`205`	`parameter to get all the items when using listing methods:`
`206`	`206`
	`207`	`+..warning::`
	`208`	`+`
	`209`	`+ The all=True option uses keyset pagination by default if order_by is not supplied,`
	`210`	`+ or if order_by="id".`
	`211`	`+`
`207`	`212`	`..code-block::python`
`208`	`213`
`209`	`214`	`all_groups= gl.groups.list(all=True)`
`@@ -391,4 +396,3 @@ parameter to that API invocation:`
`391`	`396`
`392`	`397`	`gl= gitlab.gitlab(url, token,api_version=4)`
`393`	`398`	`gl.projects.import_github(ACCESS_TOKEN,123456,"root",timeout=120.0)`
`394`		`-`

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -640,6 +640,12 @@ def http_list(self, path, query_data=None, as_list=None, **kwargs):`
`640`	`640`	`get_all=kwargs.pop("all",False)`
`641`	`641`	`url=self._build_url(path)`
`642`	`642`
	`643`	`+# use keyset pagination automatically, if all=True`
	`644`	`+order_by=kwargs.get("order_by")`
	`645`	`+ifget_alland (notorder_byororder_by=="id"):`
	`646`	`+kwargs["pagination"]="keyset"`
	`647`	`+kwargs["order_by"]="id"`
	`648`	`+`
`643`	`649`	`ifget_allisTrueandas_listisTrue:`
`644`	`650`	`returnlist(GitlabList(self,url,query_data,**kwargs))`
`645`	`651`

Comments

(0)