Mar 5, 2018 · Feb 5, 2018
diff --git a/docs/gl_objects/builds.py b/docs/gl_objects/builds.py
 trigger.delete()
 # end trigger delete

 # pipeline trigger
 def get_or_create_trigger(project):
    trigger_decription = 'my_trigger_id'
    for t in project.triggers.list():
        if t.description == trigger_decription:
            return t
    return project.triggers.create({'description': trigger_decription})

 trigger = get_or_create_trigger(project)
 pipeline = project.trigger_pipeline('master', trigger.token, variables={"DEPLOY_ZONE": "us-west1"})
 while pipeline.finished_at is None:
    pipeline.refresh()
    os.sleep(1)

 # end pipeline trigger

 # list
 builds = project.builds.list()  # v3
 jobs = project.jobs.list()  # v4
diff --git a/docs/gl_objects/builds.rst b/docs/gl_objects/builds.rst
   :start-after: # trigger delete
   :end-before: # end trigger delete

 Full example with wait for finish:

 .. literalinclude:: builds.py
   :start-after: # pipeline trigger
   :end-before: # end pipeline trigger

 Pipeline schedule
 =================

diff --git a/gitlab/mixins.py b/gitlab/mixins.py
        return self._obj_cls(self, server_data)


 class RefreshMixin(object):
    @exc.on_http_error(exc.GitlabGetError)
    def refresh(self, **kwargs):
        """Refresh a single object from server.

        Args:
            **kwargs: Extra options to send to the Gitlab server (e.g. sudo)

        Returns None (updates the object)

        Raises:
            GitlabAuthenticationError: If authentication is not correct
            GitlabGetError: If the server cannot perform the request
        """
        path = '%s/%s' % (self.manager.path, self.id)
        server_data = self.manager.gitlab.http_get(path, **kwargs)
        self._update_attrs(server_data)


 class ListMixin(object):
    @exc.on_http_error(exc.GitlabListError)
    def list(self, **kwargs):
diff --git a/gitlab/tests/test_mixins.py b/gitlab/tests/test_mixins.py
            self.assertEqual(obj.foo, 'bar')
            self.assertEqual(obj.id, 42)

    def test_refresh_mixin(self):
        class O(RefreshMixin, FakeObject):
            pass

        @urlmatch(scheme="http", netloc="localhost", path='/api/v4/tests/42',
                  method="get")
        def resp_cont(url, request):
            headers = {'Content-Type': 'application/json'}
            content = '{"id": 42, "foo": "bar"}'
            return response(200, content, headers, None, 5, request)

        with HTTMock(resp_cont):
            mgr = FakeManager(self.gl)
            obj = O(mgr, {'id': 42})
            res = obj.refresh()
            self.assertIsNone(res)
            self.assertEqual(obj.foo, 'bar')
            self.assertEqual(obj.id, 42)

    def test_get_without_id_mixin(self):
        class M(GetWithoutIdMixin, FakeManager):
            pass
diff --git a/gitlab/v4/objects.py b/gitlab/v4/objects.py
    _from_parent_attrs = {'project_id': 'id'}


 class ProjectJob(RESTObject):
 class ProjectJob(RESTObject, RefreshMixin):
    @cli.register_custom_action('ProjectJob')
    @exc.on_http_error(exc.GitlabJobCancelError)
    def cancel(self, **kwargs):
    _from_parent_attrs = {'project_id': 'id'}


 class ProjectCommitStatus(RESTObject):
 class ProjectCommitStatus(RESTObject, RefreshMixin):
    pass


    _list_filters = ('scope',)


 class ProjectPipeline(RESTObject):
 class ProjectPipeline(RESTObject, RefreshMixin):
    _managers = (('jobs', 'ProjectPipelineJobManager'), )

    @cli.register_custom_action('ProjectPipeline')
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,6 +44,22 @@
		trigger.delete()
		# end trigger delete

		# pipeline trigger
		def get_or_create_trigger(project):
		trigger_decription = 'my_trigger_id'
		for t in project.triggers.list():
		if t.description == trigger_decription:
		return t
		return project.triggers.create({'description': trigger_decription})

		trigger = get_or_create_trigger(project)
		pipeline = project.trigger_pipeline('master', trigger.token, variables={"DEPLOY_ZONE": "us-west1"})
		while pipeline.finished_at is None:
		pipeline.refresh()
		os.sleep(1)

		# end pipeline trigger

		# list
		builds = project.builds.list() # v3
		jobs = project.jobs.list() # v4
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,6 +102,12 @@ Remove a trigger:
		:start-after: # trigger delete
		:end-before: # end trigger delete

		Full example with wait for finish:

		.. literalinclude:: builds.py
		:start-after: # pipeline trigger
		:end-before: # end pipeline trigger

		Pipeline schedule
		=================

Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -68,6 +68,25 @@ def get(self, id=None, **kwargs):
		return self._obj_cls(self, server_data)


		class RefreshMixin(object):
		@exc.on_http_error(exc.GitlabGetError)
		def refresh(self, **kwargs):
		"""Refresh a single object from server.

		Args:
		**kwargs: Extra options to send to the Gitlab server (e.g. sudo)

		Returns None (updates the object)

		Raises:
		GitlabAuthenticationError: If authentication is not correct
		GitlabGetError: If the server cannot perform the request
		"""
		path = '%s/%s' % (self.manager.path, self.id)
		server_data = self.manager.gitlab.http_get(path, **kwargs)
		self._update_attrs(server_data)


		class ListMixin(object):
		@exc.on_http_error(exc.GitlabListError)
		def list(self, **kwargs):
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -153,6 +153,25 @@ def resp_cont(url, request):
		self.assertEqual(obj.foo, 'bar')
		self.assertEqual(obj.id, 42)

		def test_refresh_mixin(self):
		class O(RefreshMixin, FakeObject):
		pass

		@urlmatch(scheme="http", netloc="localhost", path='/api/v4/tests/42',
		method="get")
		def resp_cont(url, request):
		headers = {'Content-Type': 'application/json'}
		content = '{"id": 42, "foo": "bar"}'
		return response(200, content, headers, None, 5, request)

		with HTTMock(resp_cont):
		mgr = FakeManager(self.gl)
		obj = O(mgr, {'id': 42})
		res = obj.refresh()
		self.assertIsNone(res)
		self.assertEqual(obj.foo, 'bar')
		self.assertEqual(obj.id, 42)

		def test_get_without_id_mixin(self):
		class M(GetWithoutIdMixin, FakeManager):
		pass
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -909,7 +909,7 @@ class ProjectCustomAttributeManager(RetrieveMixin, SetMixin, DeleteMixin,
		_from_parent_attrs = {'project_id': 'id'}


		class ProjectJob(RESTObject):
		class ProjectJob(RESTObject, RefreshMixin):
		@cli.register_custom_action('ProjectJob')
		@exc.on_http_error(exc.GitlabJobCancelError)
		def cancel(self, **kwargs):
Expand DownExpand Up		@@ -1045,7 +1045,7 @@ class ProjectJobManager(RetrieveMixin, RESTManager):
		_from_parent_attrs = {'project_id': 'id'}


		class ProjectCommitStatus(RESTObject):
		class ProjectCommitStatus(RESTObject, RefreshMixin):
		pass


Expand DownExpand Up		@@ -1964,7 +1964,7 @@ class ProjectPipelineJobsManager(ListMixin, RESTManager):
		_list_filters = ('scope',)


		class ProjectPipeline(RESTObject):
		class ProjectPipeline(RESTObject, RefreshMixin):
		_managers = (('jobs', 'ProjectPipelineJobManager'), )

		@cli.register_custom_action('ProjectPipeline')
Expand Down