Use custom ldap.LDAPBytesWarning class

tiran · tiran · commit 4389d9b1787b · 2017-12-07T09:11:09.000+01:00
Under Python 2, python-ldap now uses custom ldap.LDAPBytesWarning instead of BytesWarning to emit warnings in default bytes mode. Closes: python-ldap#99 Signed-off-by: Christian Heimes <cheimes@redhat.com>
diff --git a/Doc/bytes_mode.rst b/Doc/bytes_mode.rst
@@ -66,7 +66,9 @@ Unspecified: relaxed mode with warnings
 
     Text values returned from python-ldap are always ``unicode``.
     Text values supplied to python-ldap should be ``unicode``;
-    warnings are emitted when they are not.
+    warnings of type :class:`ldap.LDAPBytesWarning` are emitted when they
+    are not. :class:`ldap.LDAPBytesWarning` is a subclass of
+    :class:`BytesWarning`.
 
 Backwards-compatible behavior is not scheduled for removal until Python 2
 itself reaches end of life.
@@ -103,3 +105,18 @@ Note that only the result's *values* are of the ``bytes`` type:
             'sn': [b'Barrois'],
         }),
     ]
+
+
+Filter warning
+--------------
+
+The bytes mode warnings can be filtered out and ignored with a
+simple filter.
+
+.. code-block:: python
+
+   import warnings
+   import ldap
+
+   if hasattr(ldap, 'LDAPBytesWarning'):
+       warnings.simplefilter('ignore', ldap.LDAPBytesWarning)
diff --git a/Lib/ldap/__init__.py b/Lib/ldap/__init__.py
@@ -86,7 +86,7 @@ def release(self):
 
 from ldap.functions import open,initialize,init,get_option,set_option,escape_str,strf_secs,strp_secs
 
-from ldap.ldapobject import NO_UNIQUE_ENTRY
+from ldap.ldapobject import NO_UNIQUE_ENTRY, LDAPBytesWarning
 
 from ldap.dn import explode_dn,explode_rdn,str2dn,dn2str
 del str2dn
diff --git a/Lib/ldap/ldapobject.py b/Lib/ldap/ldapobject.py
@@ -14,6 +14,7 @@
   'LDAPObject',
   'SimpleLDAPObject',
   'ReconnectLDAPObject',
+  'LDAPBytesWarning'
 ]
 
 
@@ -37,6 +38,12 @@
 else:
   text_type = str
 
+
+class LDAPBytesWarning(BytesWarning):
+  """python-ldap bytes mode warning
+  """
+
+
 class NO_UNIQUE_ENTRY(ldap.NO_SUCH_OBJECT):
   """
   Exception raised if a LDAP search returned more than entry entry
@@ -84,7 +91,7 @@ def __init__(
         "Under Python 2, python-ldap uses bytes by default. "
         "This will be removed in Python 3 (no bytes for DN/RDN/field names). "
         "Please call initialize(..., bytes_mode=False) explicitly.",
-        BytesWarning,
+        LDAPBytesWarning,
         stacklevel=2,
       )
       bytes_mode = True
@@ -122,7 +129,7 @@ def _bytesify_input(self, value):
           warnings.warn(
             "Received non-bytes value %r with default (disabled) bytes mode; please choose an explicit "
             "option for bytes_mode on your LDAP connection" % (value,),
-            BytesWarning,
+            LDAPBytesWarning,
             stacklevel=6,
           )
           return value.encode('utf-8')
diff --git a/Tests/t_ldapobject.py b/Tests/t_ldapobject.py
@@ -19,6 +19,7 @@
 import os
 import unittest
 import pickle
+import warnings
 from slapdtest import SlapdTestCase, requires_sasl
 
 # Switch off processing .ldaprc or ldap.conf before importing _ldap
@@ -314,7 +315,41 @@ def test007_timeout(self):
         l.abandon(m)
         with self.assertRaises(ldap.TIMEOUT):
             result = l.result(m, timeout=0.001)
-        
+
+    def assertIsSubclass(self, cls, other):
+        self.assertTrue(
+            issubclass(cls, other),
+            cls.__mro__
+        )
+
+    @unittest.skipUnless(PY2, "no bytes_mode under Py3")
+    def test_ldapbyteswarning(self):
+        self.assertIsSubclass(ldap.LDAPBytesWarning, BytesWarning)
+        self.assertIsSubclass(ldap.LDAPBytesWarning, Warning)
+        self.assertIsInstance(self.server.suffix, text_type)
+        with warnings.catch_warnings(record=True) as w:
+            warnings.resetwarnings()
+            warnings.simplefilter('default')
+            conn = self._get_bytes_ldapobject(explicit=False)
+            result = conn.search_s(
+                self.server.suffix,
+                ldap.SCOPE_SUBTREE,
+                b'(cn=Foo*)',
+                attrlist=[b'*'],
+            )
+            self.assertEqual(len(result), 4)
+
+        # ReconnectLDAP only emits one warning
+        self.assertGreaterEqual(len(w), 1, w)
+        msg = w[-1]
+        self.assertIs(msg.category, ldap.LDAPBytesWarning)
+        self.assertEqual(
+            text_type(msg.message),
+            "Received non-bytes value u'%s' with default (disabled) bytes "
+            "mode; please choose an explicit option for bytes_mode on your "
+            "LDAP connection" % self.server.suffix
+        )
+
 
 class Test01_ReconnectLDAPObject(Test00_SimpleLDAPObject):
     """
