Gitlab can be used as context manager

Gauvain Pocentek · Gauvain Pocentek · commit b4f03173f33e · 2018-02-05T14:22:40.000+01:00
Fixes python-gitlab#371
diff --git a/RELEASE_NOTES.rst b/RELEASE_NOTES.rst
@@ -4,6 +4,12 @@ Release notes
 
 This page describes important changes between python-gitlab releases.
 
+Changes from 1.2 to 1.3
+=======================
+
+* ``gitlab.Gitlab`` objects can be used as context managers in a ``with``
+  block.
+
 Changes from 1.1 to 1.2
 =======================
 
diff --git a/docs/api-usage.rst b/docs/api-usage.rst
@@ -274,6 +274,23 @@ HTTP requests to the Gitlab servers.
 You can provide your own ``Session`` object with custom configuration when
 you create a ``Gitlab`` object.
 
+Context manager
+---------------
+
+You can use ``Gitlab`` objects as context managers. This makes sure that the
+``requests.Session`` object associated with a ``Gitlab`` instance is always
+properly closed when you exit a ``with`` block:
+
+.. code-block:: python
+
+   with gitlab.Gitlab(host, token) as gl:
+       gl.projects.list()
+
+.. warning::
+
+   The context manager will also close the custom ``Session`` object you might
+   have used to build a ``Gitlab`` instance.
+
 Proxy configuration
 -------------------
 
diff --git a/gitlab/__init__.py b/gitlab/__init__.py
@@ -147,6 +147,12 @@ def __init__(self, url, private_token=None, oauth_token=None, email=None,
                     manager = getattr(objects, cls_name)(self)
                     setattr(self, var_name, manager)
 
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.session.close()
+
     def __getstate__(self):
         state = self.__dict__.copy()
         state.pop('_objects')
