Add Close() method to _DropboxTransport to cleanup any network resources (#207)

* Add Close() method to _DropboxTransport to cleanup any network resources

* Added contextManager

* lint fixes

Co-authored-by: Karandeep Johar <kjohar@dropbox.com>

Author: karandeep-johar

dropbox/dropbox.py

@@ -663,6 +663,19 @@ def with_path_root(self, path_root):
             headers=new_headers
         )
 
+    def close(self):
+        """
+        Cleans up all resources like the request session/network connection.
+        """
+        self._session.close()
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *args):
+        self.close()
+
+
 class Dropbox(_DropboxTransport, DropboxBase):
     """
     Use this class to make requests to the Dropbox API using a user's access

example/back-up-and-restore/backup-and-restore-example.py

@@ -76,24 +76,24 @@ def select_revision():
 
     # Create an instance of a Dropbox class, which can make requests to the API.
     print("Creating a Dropbox object...")
-    dbx = dropbox.Dropbox(TOKEN)
+    with dropbox.Dropbox(TOKEN) as dbx:
 
-    # Check that the access token is valid
-    try:
-        dbx.users_get_current_account()
-    except AuthError:
-        sys.exit("ERROR: Invalid access token; try re-generating an "
-            "access token from the app console on the web.")
+        # Check that the access token is valid
+        try:
+            dbx.users_get_current_account()
+        except AuthError:
+            sys.exit("ERROR: Invalid access token; try re-generating an "
+                "access token from the app console on the web.")
 
-    # Create a backup of the current settings file
-    backup()
+        # Create a backup of the current settings file
+        backup()
 
-    # Change the user's file, create another backup
-    change_local_file("updated")
-    backup()
+        # Change the user's file, create another backup
+        change_local_file(b"updated")
+        backup()
 
-    # Restore the local and Dropbox files to a certain revision
-    to_rev = select_revision()
-    restore(to_rev)
+        # Restore the local and Dropbox files to a certain revision
+        to_rev = select_revision()
+        restore(to_rev)
 
-    print("Done!")
+        print("Done!")

example/oauth/commandline-oauth-pkce.py

@@ -26,6 +26,6 @@
     print('Error: %s' % (e,))
     exit(1)
 
-dbx = dropbox.Dropbox(oauth2_refresh_token=oauth_result.refresh_token, app_key=APP_KEY)
-dbx.users_get_current_account()
-print("Successfully set up client!")
+with dropbox.Dropbox(oauth2_refresh_token=oauth_result.refresh_token, app_key=APP_KEY) as dbx:
+    dbx.users_get_current_account()
+    print("Successfully set up client!")

example/oauth/commandline-oauth-scopes.py

@@ -80,9 +80,9 @@
     print('Error: %s' % (e,))
     exit(1)
 
-dbx = dropbox.Dropbox(oauth2_access_token=oauth_result.access_token,
-                      oauth2_access_token_expiration=oauth_result.expires_at,
-                      oauth2_refresh_token=oauth_result.refresh_token,
-                      app_key=APP_KEY,
-                      app_secret=APP_SECRET)
-print("Successfully set up client!")
+with dropbox.Dropbox(oauth2_access_token=oauth_result.access_token,
+                     oauth2_access_token_expiration=oauth_result.expires_at,
+                     oauth2_refresh_token=oauth_result.refresh_token,
+                     app_key=APP_KEY,
+                     app_secret=APP_SECRET):
+    print("Successfully set up client!")

example/oauth/commandline-oauth.py

@@ -24,6 +24,6 @@
     print('Error: %s' % (e,))
     exit(1)
 
-dbx = dropbox.Dropbox(oauth2_access_token=oauth_result.access_token)
-dbx.users_get_current_account()
-print("Successfully set up client!")
+with dropbox.Dropbox(oauth2_access_token=oauth_result.access_token) as dbx:
+    dbx.users_get_current_account()
+    print("Successfully set up client!")

example/updown.py

@@ -122,6 +122,8 @@ def main():
                 print('OK, skipping directory:', name)
         dirs[:] = keep
 
+    dbx.close()
+
 def list_folder(dbx, folder, subfolder):
     """List a folder.