@@ -93,7 +93,8 @@ class SimpleLDAPObject:
9393
9494 def __init__ (
9595 self ,uri ,
96- trace_level = 0 ,trace_file = None ,trace_stack_limit = 5 ,bytes_mode = None
96+ trace_level = 0 ,trace_file = None ,trace_stack_limit = 5 ,bytes_mode = None ,
97+ bytes_strictness = None ,
9798 ):
9899 self ._trace_level = trace_level
99100 self ._trace_file = trace_file or sys .stdout
@@ -107,20 +108,26 @@ def __init__(
107108 # Bytes mode
108109 # ----------
109110
110- # By default, raise a TypeError when receiving invalid args
111- self .bytes_mode_hardfail = True
112- if bytes_mode is None and PY2 :
113- _raise_byteswarning (
114- "Under Python 2, python-ldap uses bytes by default. "
115- "This will be removed in Python 3 (no bytes for DN/RDN/field names). "
116- "Please call initialize(..., bytes_mode=False) explicitly." )
117- bytes_mode = True
118- # Disable hard failure when running in backwards compatibility mode.
119- self .bytes_mode_hardfail = False
120- elif bytes_mode and not PY2 :
121- raise ValueError ("bytes_mode is *not* supported under Python 3." )
122- # On by default on Py2, off on Py3.
111+ if PY2 :
112+ if bytes_mode is None :
113+ bytes_mode = True
114+ if bytes_strictness is None :
115+ _raise_byteswarning (
116+ "Under Python 2, python-ldap uses bytes by default. "
117+ "This will be removed in Python 3 (no bytes for "
118+ "DN/RDN/field names). "
119+ "Please call initialize(..., bytes_mode=False) explicitly." )
120+ bytes_strictness = 'warn'
121+ else :
122+ if bytes_strictness is None :
123+ bytes_strictness = 'error'
124+ else :
125+ if bytes_mode :
126+ raise ValueError ("bytes_mode is *not* supported under Python 3." )
127+ bytes_mode = False
128+ bytes_strictness = 'error'
123129 self .bytes_mode = bytes_mode
130+ self .bytes_strictness = bytes_strictness
124131
125132 def _bytesify_input (self , arg_name , value ):
126133 """Adapt a value following bytes_mode in Python 2.
@@ -130,38 +137,46 @@ def _bytesify_input(self, arg_name, value):
130137 With bytes_mode ON, takes bytes or None and returns bytes or None.
131138 With bytes_mode OFF, takes unicode or None and returns bytes or None.
132139
133- This function should be applied on all text inputs (distinguished names
134- and attribute names in modlists) to convert them to the bytes expected
135- by the C bindings .
140+ For the wrong argument type (unicode or bytes, respectively),
141+ behavior depends on the bytes_strictness setting.
142+ In all cases, bytes or None are returned (or an exception is raised) .
136143 """
137144 if not PY2 :
138145 return value
139-
140146 if value is None :
141147 return value
148+
142149 elif self .bytes_mode :
143150 if isinstance (value , bytes ):
144151 return value
152+ elif self .bytes_strictness == 'silent' :
153+ pass
154+ elif self .bytes_strictness == 'warn' :
155+ _raise_byteswarning (
156+ "Received non-bytes value for '{}' in bytes mode; "
157+ "please choose an explicit "
158+ "option for bytes_mode on your LDAP connection" .format (arg_name ))
145159 else :
146- if self .bytes_mode_hardfail :
147160 raise TypeError (
148161 "All provided fields *must* be bytes when bytes mode is on; "
149162 "got type '{}' for '{}'." .format (type (value ).__name__ , arg_name )
150163 )
151- else :
152- _raise_byteswarning (
153- "Received non-bytes value for '{}' with default (disabled) bytes mode; "
154- "please choose an explicit "
155- "option for bytes_mode on your LDAP connection" .format (arg_name ))
156- return value .encode ('utf-8' )
164+ return value .encode ('utf-8' )
157165 else :
158- if not isinstance (value , text_type ):
166+ if isinstance (value , unicode ):
167+ return value .encode ('utf-8' )
168+ elif self .bytes_strictness == 'silent' :
169+ pass
170+ elif self .bytes_strictness == 'warn' :
171+ _raise_byteswarning (
172+ "Received non-text value for '{}' with bytes_mode off and "
173+ "bytes_strictness='warn'" .format (arg_name ))
174+ else :
159175 raise TypeError (
160176 "All provided fields *must* be text when bytes mode is off; "
161177 "got type '{}' for '{}'." .format (type (value ).__name__ , arg_name )
162178 )
163- assert not isinstance (value , bytes )
164- return value .encode ('utf-8' )
179+ return value
165180
166181 def _bytesify_modlist (self , arg_name , modlist , with_opcode ):
167182 """Adapt a modlist according to bytes_mode.
@@ -1064,7 +1079,7 @@ class ReconnectLDAPObject(SimpleLDAPObject):
10641079 def __init__ (
10651080 self ,uri ,
10661081 trace_level = 0 ,trace_file = None ,trace_stack_limit = 5 ,bytes_mode = None ,
1067- retry_max = 1 ,retry_delay = 60.0
1082+ bytes_strictness = None , retry_max = 1 , retry_delay = 60.0
10681083 ):
10691084 """
10701085 Parameters like SimpleLDAPObject.__init__() with these
@@ -1078,7 +1093,9 @@ def __init__(
10781093 self ._uri = uri
10791094 self ._options = []
10801095 self ._last_bind = None
1081- SimpleLDAPObject .__init__ (self ,uri ,trace_level ,trace_file ,trace_stack_limit ,bytes_mode )
1096+ SimpleLDAPObject .__init__ (self , uri , trace_level , trace_file ,
1097+ trace_stack_limit , bytes_mode ,
1098+ bytes_strictness = bytes_strictness )
10821099 self ._reconnect_lock = ldap .LDAPLock (desc = 'reconnect lock within %s' % (repr (self )))
10831100 self ._retry_max = retry_max
10841101 self ._retry_delay = retry_delay
@@ -1097,6 +1114,11 @@ def __getstate__(self):
10971114
10981115 def __setstate__ (self ,d ):
10991116 """set up the object from pickled data"""
1117+ hardfail = d .get ('bytes_mode_hardfail' )
1118+ if hardfail :
1119+ d .setdefault ('bytes_strictness' , 'error' )
1120+ else :
1121+ d .setdefault ('bytes_strictness' , 'warn' )
11001122 self .__dict__ .update (d )
11011123 self ._last_bind = getattr (SimpleLDAPObject , self ._last_bind [0 ]), self ._last_bind [1 ], self ._last_bind [2 ]
11021124 self ._ldap_object_lock = self ._ldap_lock ()
0 commit comments