ProjectMergeRequest.pipelines() returns a 'list' instead of documented 'RESTObjectList' #1312

Activity

1. nejch commented on Feb 21, 2021

   

   nejch

   on Feb 21, 2021

   Last edited by nejch

   Member

   More actions

   Seems like the MR pipelines endpoint has a custom method that only does http_get() at the moment that just serializes the json:

   python-gitlab/gitlab/v4/objects/merge_requests.py

   Lines 208 to 223 in 3381700

   	def pipelines(self, **kwargs):
   	"""List the merge request pipelines.
   	Args:
   	**kwargs: Extra options to send to the server (e.g. sudo)
   	Raises:
   	GitlabAuthenticationError: If authentication is not correct
   	GitlabListError: If the list could not be retrieved
   	Returns:
   	RESTObjectList: List of changes
   	"""
   	path = "%s/%s/pipelines" % (self.manager.path, self.get_id())
   	return self.manager.gitlab.http_get(path, **kwargs)

   Hmm, it's an easy fix but might be better to deprecate this and add proper managers to MRs now that they also have a create pipeline API endpoint and call them like project pipelines:

   merge_request.pipelines.list()
merge_request.pipelines.create()

   Related to #1239

   👍React with 👍1Reacted by Michael Heyns
2. nejch commented on Feb 23, 2021

   

   nejch

   on Feb 23, 2021

   Member

   More actions

   @beanaroo this should be fixed when #1323 is merged and released, but then please switch to the list() method asap as the old one will be removed.

   BTW it will still return a list with this new method, unless you specifically ask for a generator (as_list=False), but at least the docstrings will be accurate.
3. msune commented on Mar 27, 2021

   

   msune

   on Mar 27, 2021

   More actions

   Hi,

   Wondering if what I see is remotely related.

   mr.pipelines() doesn't seem to honour all=True (that particular MR has 140+ pipelines):

   ipdb> len(mr.pipelines())
   20
   ipdb> len(mr.pipelines(all=True, lazy=False))
   20
   

   However, trying directly the REST API with per_page=100, which I believe is the max as per Gitlab's docs, returns the first 100 elements:

   https://gitlab.acme.com/api/v4//projects/59/merge_requests/1307/pipelines?per_page=100`
   

   Am I missing something fundamental here? Should I open a separate issue or is it related?
4. nejch commented on May 1, 2021

   

   nejch

   on May 1, 2021

   Last edited by nejch

   Member

   More actions

   @msune yes this is most likely related because all=True is implemented via http_list. So this will be fixed after merging the PR linked above.
5. JohnVillalovos

   closed this as completedin #1323on Jun 14, 2021
6. github-actions

   locked as resolved and limited conversation to collaborators on Jun 20, 2022