Changeset 226:d5a9a8aa94d5

Timestamp:

31/05/11 13:32:19 (12 months ago)

Author:

Menno Smits <menno@…>

Branch:

default

Message:

Expose debugging functionality (#90)

As part of this, moved IMAP4 creation to a separate method to make
unit testing cleaner and easier.

Files:

• NEWS (modified) (1 diff)
• imapclient/imapclient.py (modified) (3 diffs)
• imapclient/test/test_IMAPClient.py (modified) (2 diffs)
• imapclient/test/testable_imapclient.py (modified) (1 diff)

NEWS

@@ -21 +21 @@
 --------------
 interact.py can now read livetest.py INI files (#66)
+Added "debug" propety and setting of a log file (#90)
 
 Small Bug Fixes

imapclient/imapclient.py

@@ -4 +4 @@
 
 import re
-import response_lexer
-from operator import itemgetter
 import select
 import socket
+import sys
 import warnings
+from datetime import datetime
+from operator import itemgetter
 
 import imaplib
-#imaplib.Debug = 5
+import response_lexer
+
     
 try:
@@ -102 +104 @@
         @param ssl: Make an SSL connection (default is False)
         """
-        if ssl:
-            ImapClass = imaplib.IMAP4_SSL
-            default_port = 993
-        else:
-            ImapClass = imaplib.IMAP4
-            default_port = 143
-
         if port is None:
-            port = default_port
-
+            port = ssl and 993 or 143
+
+        self.host = host
+        self.port = port
+        self.ssl = ssl
         self.use_uid = use_uid
-        self.ssl = ssl
         self.folder_encode = True
-        self._imap = ImapClass(host, port)
+        self.log_file = sys.stderr
+
+        self._imap = self._create_IMAP4()
+        self._imap._mesg = self._log    # patch in custom debug log method
         self._idle_tag = None
 
-   
+    def _create_IMAP4(self):
+        # Create the IMAP instance in a separate method to make unit tests easier
+        ImapClass = self.ssl and imaplib.IMAP4_SSL or imaplib.IMAP4
+        return ImapClass(self.host, self.port)
+
     def login(self, username, password):
         """Perform a simple login
@@ -781 +785 @@
         return _quote_arg(name)
 
+    def __debug_get(self):
+        return self._imap.debug
+
+    def __debug_set(self, level):
+        if level is True:
+            level = 4
+        elif level is False:
+            level = 0
+        self._imap.debug = level
+
+    debug = property(__debug_get, __debug_set,
+                     doc="Set debug level. Integers from 0 to 5 or, True and " \
+                         "False can be used. True specifies debug level 4. " \
+                         "Debug output goes to stderr.")
+
+    def _log(self, text):
+        self.log_file.write('%s %s\n' % (datetime.now().strftime('%M:%S.%f'), text))
+        self.log_file.flush()
+        
 
 def messages_to_str(messages):

imapclient/test/test_IMAPClient.py

@@ -5 +5 @@
 import itertools
 import socket
+import sys
 import time
 from datetime import datetime
+from StringIO import StringIO
 from imapclient.fixed_offset import FixedOffset
 from imapclient.imapclient import datetime_to_imap
@@ -246 +248 @@
         self.assertListEqual([(99, 'EXISTS')], responses)
 
+
+class TestDebugLogging(IMAPClientTest):
+
+    def test_default_is_stderr(self):
+        self.assertIs(self.client.log_file, sys.stderr)
+
+    def test_IMAP_is_patched(self):
+        log = StringIO()
+        self.client.log_file = log
+
+        self.client._log('one')
+        self.client._imap._mesg('two')
+
+        output = log.getvalue()
+        self.assertIn('one', output)
+        self.assertIn('two', output)
+        
+
+
 if __name__ == '__main__':
     unittest.main()

imapclient/test/testable_imapclient.py

@@ -9 +9 @@
 
     def __init__(self):
-        self._imap = Mock()
-        self.use_uid = True
-        self.folder_encode = True
+        super(TestableIMAPClient, self).__init__('somehost')
 
+    def _create_IMAP4(self):
+        return Mock()