Avoid garbage collection for requests.Session (#1189)

* workaround for garbage collection

* add missing import

* linting issues (wrong import order)

* fix imports

CHANGELOG.md

@@ -26,6 +26,7 @@ Add your changes below.
 - Fixed scripts in examples directory that didn't run correctly
 - Updated documentation for `Client.current_user_top_artists` to indicate maximum number of artists limit
 - Set auth cache file permissions to `600`: https://github.com/spotipy-dev/spotipy/security/advisories/GHSA-pwhh-q4h6-w599
+- Fixed `__del__` methods by preventing garbage collection for `requests.Session`
 
 ### Changed
 

spotipy/client.py

@@ -11,7 +11,7 @@ from collections import defaultdict
 import requests
 
 from spotipy.exceptions import SpotifyException
-from spotipy.util import Retry
+from spotipy.util import REQUESTS_SESSION, Retry
 
 logger = logging.getLogger(__name__)
 
@@ -211,11 +211,8 @@ class Spotify:
 
     def __del__(self):
         """Make sure the connection (pool) gets closed"""
-        try:
+        if getattr(self, "_session", None) and isinstance(self._session, REQUESTS_SESSION):
-            if isinstance(self._session, requests.Session):
+            self._session.close()
-                self._session.close()
-        except AttributeError:
-            pass
 
     def _build_session(self):
         self._session = requests.Session()

spotipy/oauth2.py

@@ -21,7 +21,8 @@ import requests
 
 from spotipy.cache_handler import CacheFileHandler, CacheHandler
 from spotipy.exceptions import SpotifyOauthError, SpotifyStateError
-from spotipy.util import CLIENT_CREDS_ENV_VARS, get_host_port, normalize_scope
+from spotipy.util import (CLIENT_CREDS_ENV_VARS, REQUESTS_SESSION,
+                          get_host_port, normalize_scope)
 
 logger = logging.getLogger(__name__)
 
@@ -122,7 +123,7 @@ class SpotifyAuthBase:
 
     def __del__(self):
         """Make sure the connection (pool) gets closed"""
-        if isinstance(self._session, requests.Session):
+        if getattr(self, "_session", None) and isinstance(self._session, REQUESTS_SESSION):
             self._session.close()
 
 

spotipy/util.py

@@ -9,6 +9,7 @@ import os
 import warnings
 from types import TracebackType
 
+import requests
 import urllib3
 
 import spotipy
@@ -22,6 +23,9 @@ CLIENT_CREDS_ENV_VARS = {
     "redirect_uri": "SPOTIPY_REDIRECT_URI",
 }
 
+# workaround for garbage collection
+REQUESTS_SESSION = requests.Session
+
 
 def prompt_for_user_token(
     username=None,