Deprecate GetFromListMixin

This mixin provides a workaround for get() for GitLab objects that don't
implement a 'get a single object' API. We are now getting conflicts
because GitLab adds GET methods, and this is against the "Implement only
what exists in the API" strategy.

Also use the proper GET API call for objects that support it.

1 files changed, 9 insertions, 0 deletions

diff --git a/gitlab/mixins.py b/gitlab/mixins.py
index 88fea2d..d3e5727 100644
--- a/gitlab/mixins.py
+++ b/gitlab/mixins.py
@@ -15,6 +15,8 @@
 # You should have received a copy of the GNU Lesser General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
+import warnings
+
 import gitlab
 from gitlab import base
 from gitlab import cli
@@ -130,9 +132,13 @@ class ListMixin(object):
 
 
 class GetFromListMixin(ListMixin):
+    """This mixin is deprecated."""
+
     def get(self, id, **kwargs):
         """Retrieve a single object.
 
+        This Method is deprecated.
+
         Args:
             id (int or str): ID of the object to retrieve
             **kwargs: Extra options to send to the Gitlab server (e.g. sudo)
@@ -144,6 +150,9 @@ class GetFromListMixin(ListMixin):
             GitlabAuthenticationError: If authentication is not correct
             GitlabGetError: If the server cannot perform the request
         """
+        warnings.warn('The get() method for this object is deprecated '
+                      'and will be removed in a future version.',
+                       DeprecationWarning)
         try:
             gen = self.list()
         except exc.GitlabListError: