Added __del__ methods for classes that hold on to resources that need to be cleaned up. This should prevent resource leakage when these objects leave scope due to misuse or unhandled exceptions.

Author: andymccurdy

CHANGES

@@ -1,4 +1,7 @@
 * 2.4.10 (in development)
+    * Added __del__ methods for classes that hold on to resources that need to
+      be cleaned up. This should prevent resource leakage when these objects
+      leave scope due to misuse or unhandled exceptions.
     * Added the ECHO command for completeness.
     * Fixed a bug where attempting to subscribe to a PubSub channel of a Redis
       server that's down would blow out the stack. Fixes #179 and #195. Thanks

redis/client.py

@@ -1169,6 +1169,22 @@ def __init__(self, connection_pool, shard_hint=None):
             ('subscribe', 'psubscribe', 'unsubscribe', 'punsubscribe')
             )
 
+    def __del__(self):
+        try:
+            # if this object went out of scope prior to shutting down
+            # subscriptions, close the connection manually before
+            # returning it to the connection pool
+            if self.connection and (self.channels or self.patterns):
+                self.connection.disconnect()
+            self.reset()
+        except:
+            pass
+
+    def reset(self):
+        if self.connection:
+            self.connection_pool.release(self.connection)
+            self.connection = None
+
     def execute_command(self, *args, **kwargs):
         "Execute a publish/subscribe command"
         if self.connection is None:
@@ -1202,8 +1218,7 @@ def parse_response(self):
             # if we've just unsubscribed from the remaining channels,
             # release the connection back to the pool
             if not self.subscription_count:
-                self.connection_pool.release(self.connection)
-                self.connection = None
+                self.reset()
         return response
 
     def psubscribe(self, patterns):
@@ -1309,6 +1324,12 @@ def __enter__(self):
     def __exit__(self, exc_type, exc_value, traceback):
         self.reset()
 
+    def __del__(self):
+        try:
+            self.reset()
+        except:
+            pass
+
     def reset(self):
         self.command_stack = []
         # make sure to reset the connection state in the event that we were

redis/connection.py

@@ -4,9 +4,16 @@
 from redis.exceptions import ConnectionError, ResponseError, InvalidResponse
 
 class PythonParser(object):
+    "Plain Python parsing class"
     def __init__(self):
         self._fp = None
 
+    def __del__(self):
+        try:
+            self.on_disconnect()
+        except:
+            pass
+
     def on_connect(self, connection):
         "Called when the socket connects"
         self._fp = connection._sock.makefile('r')
@@ -68,6 +75,13 @@ def read_response(self):
         raise InvalidResponse("Protocol Error")
 
 class HiredisParser(object):
+    "Parser class for connections using Hiredis"
+    def __del__(self):
+        try:
+            self.on_disconnect()
+        except:
+            pass
+
     def on_connect(self, connection):
         self._sock = connection._sock
         self._reader = hiredis.Reader(
@@ -119,6 +133,12 @@ def __init__(self, host='localhost', port=6379, db=0, password=None,
         self._sock = None
         self._parser = parser_class()
 
+    def __del__(self):
+        try:
+            self.disconnect()
+        except:
+            pass
+
     def connect(self):
         "Connects to the Redis server if not already connected"
         if self._sock:
@@ -148,7 +168,6 @@ def _error_message(self, exception):
             return "Error %s connecting %s:%s. %s." % \
                 (exception.args[0], self.host, self.port, exception.args[1])
 
-
     def on_connect(self):
         "Initialize the connection, authenticate and select a database"
         self._parser.on_connect(self)