Add laziness to get()

Gauvain Pocentek · Gauvain Pocentek · commit 61fba8431d04 · 2017-06-11T13:44:05.000+02:00
The goal is to create empty objects (no API called) but give access to
the managers. Using this users can reduce the number of API calls but
still use the same API to access children objects.

For example the following will only make one API call but will still get
the result right:

gl.projects.get(49, lazy=True).issues.get(2, lazy=True).notes.list()

This removes the need for more complex managers attributes (e.g.
gl.project_issue_notes)
diff --git a/gitlab/mixins.py b/gitlab/mixins.py
@@ -21,11 +21,14 @@
 
 
 class GetMixin(object):
-    def get(self, id, **kwargs):
+    def get(self, id, lazy=False, **kwargs):
         """Retrieve a single object.
 
         Args:
             id (int or str): ID of the object to retrieve
+            lazy (bool): If True, don't request the server, but create a
+                         shallow object giving access to the managers. This is
+                         useful if you want to avoid useless calls to the API.
             **kwargs: Extra data to send to the Gitlab server (e.g. sudo)
 
         Returns:
@@ -35,6 +38,9 @@ def get(self, id, **kwargs):
             GitlabGetError: If the server cannot perform the request.
         """
         path = '%s/%s' % (self.path, id)
+        if lazy is True:
+            return self._obj_cls(self, {self._obj_cls._id_attr: id})
+
         server_data = self.gitlab.http_get(path, **kwargs)
         return self._obj_cls(self, server_data)
 
