Merge pull request #705 from pyinat/close-sqlite

Clean up SQLite connections when session is closed

Author: JWCook

HISTORY.md

@@ -113,6 +113,7 @@ In addition, checking attributes on nested objects will not raise `AttributeErro
 * Fix corner case resulting in `observed_on` not being converted to `datetime`
 * Fix list slicing on custom collection types (`TaxonCounts`, etc.)
 * Fix pprint with empty results
+* Close any open cache or ratelimit SQLite connections when closing or garbage-collecting `ClientSession`
 
 ### Other Changes
 * Add support for python 3.15

pyinaturalist/client/session.py

@@ -438,6 +438,21 @@ def _validate_json(
             response.json = lambda **kwargs: response_json  # type: ignore
             return response
 
+    def close(self):
+        """Close cache and rate limit backends to avoid unclosed SQLite connections."""
+        self.cache.close()
+        for bucket in self.limiter.bucket_factory.get_buckets() or []:
+            bucket.close()
+        self.limiter.close()
+
+        super().close()
+
+    def __del__(self):
+        try:
+            self.close()
+        except Exception:
+            pass
+
 
 class RequestTimeout(Timeout):
     """Timeout class that adjusts timeouts for write operations"""

test/client/test_session.py

@@ -385,3 +385,63 @@ def test_get_refresh_params():
     assert session.get_refresh_params('test') == {'refresh': True, 'v': 2}
     sleep(2)
     assert session.get_refresh_params('test') == {'refresh': True}
+
+
+def test_session_close():
+    from unittest.mock import MagicMock, patch
+
+    from requests_cache import CacheMixin
+
+    session = ClientSession()
+    mock_bucket_1 = MagicMock()
+    mock_bucket_2 = MagicMock()
+
+    # Patch CacheMixin.close to stop the super() chain and isolate ClientSession.close() logic
+    with (
+        patch.object(CacheMixin, 'close'),
+        patch.object(session.cache, 'close') as mock_cache_close,
+        patch.object(session.limiter, 'close') as mock_limiter_close,
+        patch.object(
+            session.limiter.bucket_factory,
+            'get_buckets',
+            return_value=[mock_bucket_1, mock_bucket_2],
+        ),
+    ):
+        session.close()
+
+        mock_cache_close.assert_called_once()
+        mock_limiter_close.assert_called_once()
+        mock_bucket_1.close.assert_called_once()
+        mock_bucket_2.close.assert_called_once()
+
+
+def test_session_close__no_buckets():
+    from unittest.mock import patch
+
+    from requests_cache import CacheMixin
+
+    session = ClientSession()
+    # Patch CacheMixin.close to stop the super() chain; patch get_buckets() to return None
+    with (
+        patch.object(CacheMixin, 'close'),
+        patch.object(session.limiter.bucket_factory, 'get_buckets', return_value=None),
+        patch.object(session.limiter, 'close'),
+    ):
+        session.close()  # should not raise
+
+
+def test_session_del__suppresses_exceptions():
+    from unittest.mock import patch
+
+    session = ClientSession()
+    with patch.object(session, 'close', side_effect=Exception('boom')):
+        session.__del__()  # should not raise
+
+
+def test_session_del__calls_close():
+    from unittest.mock import MagicMock, patch
+
+    session = ClientSession()
+    with patch.object(session, 'close', MagicMock()) as mock_close:
+        session.__del__()
+    mock_close.assert_called_once()

test/conftest.py

@@ -15,6 +15,7 @@
 import pytest
 from requests import HTTPError, Response
 from requests_cache import DO_NOT_CACHE, BaseCache
+from requests_ratelimiter import InMemoryBucket
 
 from pyinaturalist import enable_logging
 from pyinaturalist.client import ClientSession
@@ -52,6 +53,7 @@ class TestSession(ClientSession):
     """Session class to use for tests, which disables rate-limiting and caching"""
 
     def __init__(self, *args, **kwargs):
+        kwargs.setdefault('bucket_class', InMemoryBucket)
         super().__init__(*args, **kwargs)
         self.limiter = MagicMock()
         self.cache = BaseCache(expire_after=DO_NOT_CACHE)