Skip to content

Make bytes mode TypeError more useful #165

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 22, 2018
Merged

Make bytes mode TypeError more useful #165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1e9c903
Make bytes mode TypeError more useful
tiran Jan 11, 2018
52fc21d
Remove value from TypeError
tiran Jan 22, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 8 additions & 2 deletions Lib/ldap/ldapobject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,10 @@ def _bytesify_input(self, arg_name, value):
return value
else:
if self.bytes_mode_hardfail:
raise TypeError("All provided fields *must* be bytes when bytes mode is on; got %r" % (value,))
raise TypeError(
"All provided fields *must* be bytes when bytes mode is on; "
"got type '{}' for '{}'.".format(type(value).__name__, arg_name)
)
else:
_raise_byteswarning(
"Received non-bytes value for '{}' with default (disabled) bytes mode; "
Expand All @@ -153,7 +156,10 @@ def _bytesify_input(self, arg_name, value):
return value.encode('utf-8')
else:
if not isinstance(value, text_type):
raise TypeError("All provided fields *must* be text when bytes mode is off; got %r" % (value,))
raise TypeError(
"All provided fields *must* be text when bytes mode is off; "
"got type '{}' for '{}'.".format(type(value).__name__, arg_name)
)
assert not isinstance(value, bytes)
return value.encode('utf-8')

Expand Down
54 changes: 27 additions & 27 deletions Modules/LDAPObject.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,16 +108,16 @@ Tuple_to_LDAPMod( PyObject* tup, int no_op )
Py_ssize_t i, len, nstrs;

if (!PyTuple_Check(tup)) {
LDAPerror_TypeError("expected a tuple", tup);
LDAPerror_TypeError("Tuple_to_LDAPMod(): expected a tuple", tup);
return NULL;
}

if (no_op) {
if (!PyArg_ParseTuple( tup, "sO", &type, &list ))
if (!PyArg_ParseTuple( tup, "sO:Tuple_to_LDAPMod", &type, &list ))
return NULL;
op = 0;
} else {
if (!PyArg_ParseTuple( tup, "isO", &op, &type, &list ))
if (!PyArg_ParseTuple( tup, "isO:Tuple_to_LDAPMod", &op, &type, &list ))
return NULL;
}

Expand Down Expand Up @@ -161,7 +161,7 @@ Tuple_to_LDAPMod( PyObject* tup, int no_op )
if (item == NULL)
goto error;
if (!PyBytes_Check(item)) {
LDAPerror_TypeError("expected a byte string in the list", item);
LDAPerror_TypeError("Tuple_to_LDAPMod(): expected a byte string in the list", item);
goto error;
}
lm->mod_bvalues[i]->bv_len = PyBytes_Size(item);
Expand Down Expand Up @@ -206,14 +206,14 @@ List_to_LDAPMods( PyObject *list, int no_op ) {
PyObject *item;

if (!PySequence_Check(list)) {
LDAPerror_TypeError("expected list of tuples", list);
LDAPerror_TypeError("List_to_LDAPMods(): expected list of tuples", list);
return NULL;
}

len = PySequence_Length(list);

if (len < 0) {
LDAPerror_TypeError("expected list of tuples", list);
LDAPerror_TypeError("List_to_LDAPMods(): expected list of tuples", list);
return NULL;
}

Expand Down Expand Up @@ -262,7 +262,7 @@ attrs_from_List( PyObject *attrlist, char***attrsp) {
#endif
/* caught by John Benninghoff <johnb@netscape.com> */
LDAPerror_TypeError(
"expected *list* of strings, not a string", attrlist);
"attrs_from_List(): expected *list* of strings, not a string", attrlist);
goto error;
} else {
PyObject *item = NULL;
Expand Down Expand Up @@ -291,15 +291,15 @@ attrs_from_List( PyObject *attrlist, char***attrsp) {
#if PY_MAJOR_VERSION == 2
/* Encoded in Python to UTF-8 */
if (!PyBytes_Check(item)) {
LDAPerror_TypeError("expected bytes in list", item);
LDAPerror_TypeError("attrs_from_List(): expected bytes in list", item);
goto error;
}
if (PyBytes_AsStringAndSize(item, &str, &strlen) == -1) {
goto error;
}
#else
if (!PyUnicode_Check(item)) {
LDAPerror_TypeError("expected string in list", item);
LDAPerror_TypeError("attrs_from_List(): expected string in list", item);
goto error;
}
str = PyUnicode_AsUTF8AndSize(item, &strlen);
Expand Down Expand Up @@ -361,7 +361,7 @@ l_ldap_unbind_ext( LDAPObject* self, PyObject* args )

int ldaperror;

if (!PyArg_ParseTuple( args, "|OO", &serverctrls, &clientctrls)) return NULL;
if (!PyArg_ParseTuple( args, "|OO:unbind_ext", &serverctrls, &clientctrls)) return NULL;
if (not_valid(self)) return NULL;

if (!PyNone_Check(serverctrls)) {
Expand Down Expand Up @@ -404,7 +404,7 @@ l_ldap_abandon_ext( LDAPObject* self, PyObject* args )

int ldaperror;

if (!PyArg_ParseTuple( args, "i|OO", &msgid, &serverctrls, &clientctrls)) return NULL;
if (!PyArg_ParseTuple( args, "i|OO:abandon_ext", &msgid, &serverctrls, &clientctrls)) return NULL;
if (not_valid(self)) return NULL;

if (!PyNone_Check(serverctrls)) {
Expand Down Expand Up @@ -449,7 +449,7 @@ l_ldap_add_ext( LDAPObject* self, PyObject *args )
int ldaperror;
LDAPMod **mods;

if (!PyArg_ParseTuple( args, "sO|OO", &dn, &modlist, &serverctrls, &clientctrls )) return NULL;
if (!PyArg_ParseTuple( args, "sO|OO:add_ext", &dn, &modlist, &serverctrls, &clientctrls )) return NULL;
if (not_valid(self)) return NULL;

mods = List_to_LDAPMods( modlist, 1 );
Expand Down Expand Up @@ -499,7 +499,7 @@ l_ldap_simple_bind( LDAPObject* self, PyObject* args )
LDAPControl** client_ldcs = NULL;
struct berval cred;

if (!PyArg_ParseTuple( args, "zz#|OO", &who, &cred.bv_val, &cred_len, &serverctrls, &clientctrls )) return NULL;
if (!PyArg_ParseTuple( args, "zz#|OO:simple_bind", &who, &cred.bv_val, &cred_len, &serverctrls, &clientctrls )) return NULL;
cred.bv_len = (ber_len_t) cred_len;

if (not_valid(self)) return NULL;
Expand Down Expand Up @@ -649,7 +649,7 @@ l_ldap_sasl_bind_s( LDAPObject* self, PyObject* args )
struct berval *servercred;
int ldaperror;

if (!PyArg_ParseTuple(args, "zzz#OO", &dn, &mechanism, &cred.bv_val, &cred_len, &serverctrls, &clientctrls ))
if (!PyArg_ParseTuple(args, "zzz#OO:sasl_bind_s", &dn, &mechanism, &cred.bv_val, &cred_len, &serverctrls, &clientctrls ))
return NULL;

if (not_valid(self)) return NULL;
Expand Down Expand Up @@ -713,9 +713,9 @@ l_ldap_sasl_interactive_bind_s( LDAPObject* self, PyObject* args )
* "i" otherwise.
*/
#if (PY_MAJOR_VERSION == 2) && (PY_MINOR_VERSION < 3)
if (!PyArg_ParseTuple(args, "sOOOi", &who, &SASLObject, &serverctrls, &clientctrls, &sasl_flags ))
if (!PyArg_ParseTuple(args, "sOOOi:sasl_interactive_bind_s", &who, &SASLObject, &serverctrls, &clientctrls, &sasl_flags ))
#else
if (!PyArg_ParseTuple(args, "sOOOI", &who, &SASLObject, &serverctrls, &clientctrls, &sasl_flags ))
if (!PyArg_ParseTuple(args, "sOOOI:sasl_interactive_bind_s", &who, &SASLObject, &serverctrls, &clientctrls, &sasl_flags ))
#endif
return NULL;

Expand Down Expand Up @@ -780,7 +780,7 @@ l_ldap_cancel( LDAPObject* self, PyObject* args )

int ldaperror;

if (!PyArg_ParseTuple( args, "i|OO", &cancelid, &serverctrls, &clientctrls)) return NULL;
if (!PyArg_ParseTuple( args, "i|OO:cancel", &cancelid, &serverctrls, &clientctrls)) return NULL;
if (not_valid(self)) return NULL;

if (!PyNone_Check(serverctrls)) {
Expand Down Expand Up @@ -826,7 +826,7 @@ l_ldap_compare_ext( LDAPObject* self, PyObject *args )
Py_ssize_t value_len;
struct berval value;

if (!PyArg_ParseTuple( args, "sss#|OO", &dn, &attr, &value.bv_val, &value_len, &serverctrls, &clientctrls )) return NULL;
if (!PyArg_ParseTuple( args, "sss#|OO:compare_ext", &dn, &attr, &value.bv_val, &value_len, &serverctrls, &clientctrls )) return NULL;
value.bv_len = (ber_len_t) value_len;

if (not_valid(self)) return NULL;
Expand Down Expand Up @@ -871,7 +871,7 @@ l_ldap_delete_ext( LDAPObject* self, PyObject *args )
int msgid;
int ldaperror;

if (!PyArg_ParseTuple( args, "s|OO", &dn, &serverctrls, &clientctrls )) return NULL;
if (!PyArg_ParseTuple( args, "s|OO:delete_ext", &dn, &serverctrls, &clientctrls )) return NULL;
if (not_valid(self)) return NULL;

if (!PyNone_Check(serverctrls)) {
Expand Down Expand Up @@ -916,7 +916,7 @@ l_ldap_modify_ext( LDAPObject* self, PyObject *args )
int ldaperror;
LDAPMod **mods;

if (!PyArg_ParseTuple( args, "sO|OO", &dn, &modlist, &serverctrls, &clientctrls )) return NULL;
if (!PyArg_ParseTuple( args, "sO|OO:modify_ext", &dn, &modlist, &serverctrls, &clientctrls )) return NULL;
if (not_valid(self)) return NULL;

mods = List_to_LDAPMods( modlist, 0 );
Expand Down Expand Up @@ -969,7 +969,7 @@ l_ldap_rename( LDAPObject* self, PyObject *args )
int msgid;
int ldaperror;

if (!PyArg_ParseTuple( args, "ss|ziOO", &dn, &newrdn, &newSuperior, &delold, &serverctrls, &clientctrls ))
if (!PyArg_ParseTuple( args, "ss|ziOO:rename", &dn, &newrdn, &newSuperior, &delold, &serverctrls, &clientctrls ))
return NULL;
if (not_valid(self)) return NULL;

Expand Down Expand Up @@ -1022,7 +1022,7 @@ l_ldap_result4( LDAPObject* self, PyObject *args )
char **refs = NULL;
LDAPControl **serverctrls = 0;

if (!PyArg_ParseTuple( args, "|iidiii", &msgid, &all, &timeout, &add_ctrls, &add_intermediates, &add_extop ))
if (!PyArg_ParseTuple( args, "|iidiii:result4", &msgid, &all, &timeout, &add_ctrls, &add_intermediates, &add_extop ))
return NULL;
if (not_valid(self)) return NULL;

Expand Down Expand Up @@ -1162,7 +1162,7 @@ l_ldap_search_ext( LDAPObject* self, PyObject* args )
int msgid;
int ldaperror;

if (!PyArg_ParseTuple( args, "sis|OiOOdi",
if (!PyArg_ParseTuple( args, "sis|OiOOdi:search_ext",
&base, &scope, &filter, &attrlist, &attrsonly,
&serverctrls, &clientctrls, &timeout, &sizelimit )) return NULL;
if (not_valid(self)) return NULL;
Expand Down Expand Up @@ -1224,7 +1224,7 @@ l_ldap_whoami_s( LDAPObject* self, PyObject* args )

int ldaperror;

if (!PyArg_ParseTuple( args, "|OO", &serverctrls, &clientctrls)) return NULL;
if (!PyArg_ParseTuple( args, "|OO:whoami_s", &serverctrls, &clientctrls)) return NULL;
if (not_valid(self)) return NULL;

if (!PyNone_Check(serverctrls)) {
Expand Down Expand Up @@ -1265,7 +1265,7 @@ l_ldap_start_tls_s( LDAPObject* self, PyObject* args )
{
int ldaperror;

if (!PyArg_ParseTuple( args, "" )) return NULL;
if (!PyArg_ParseTuple( args, ":start_tls_s" )) return NULL;
if (not_valid(self)) return NULL;

LDAP_BEGIN_ALLOW_THREADS( self );
Expand Down Expand Up @@ -1331,7 +1331,7 @@ l_ldap_passwd( LDAPObject* self, PyObject *args )
int msgid;
int ldaperror;

if (!PyArg_ParseTuple( args, "z#z#z#|OO", &user.bv_val, &user_len, &oldpw.bv_val, &oldpw_len, &newpw.bv_val, &newpw_len, &serverctrls, &clientctrls ))
if (!PyArg_ParseTuple( args, "z#z#z#|OO:passwd", &user.bv_val, &user_len, &oldpw.bv_val, &oldpw_len, &newpw.bv_val, &newpw_len, &serverctrls, &clientctrls ))
return NULL;

user.bv_len = (ber_len_t) user_len;
Expand Down Expand Up @@ -1387,7 +1387,7 @@ l_ldap_extended_operation( LDAPObject* self, PyObject *args )
int msgid;
int ldaperror;

if (!PyArg_ParseTuple( args, "sz#|OO", &reqoid, &reqvalue.bv_val, &reqvalue.bv_len, &serverctrls, &clientctrls ))
if (!PyArg_ParseTuple( args, "sz#|OO:extended_operation", &reqoid, &reqvalue.bv_val, &reqvalue.bv_len, &serverctrls, &clientctrls ))
return NULL;

if (not_valid(self)) return NULL;
Expand Down
2 changes: 1 addition & 1 deletion Modules/functions.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ l_ldap_initialize(PyObject* unused, PyObject *args)
LDAP *ld = NULL;
int ret;

if (!PyArg_ParseTuple(args, "s", &uri))
if (!PyArg_ParseTuple(args, "s:initialize", &uri))
return NULL;

Py_BEGIN_ALLOW_THREADS
Expand Down
8 changes: 4 additions & 4 deletions Modules/ldapcontrol.c
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,11 @@ Tuple_to_LDAPControl( PyObject* tup )
Py_ssize_t len;

if (!PyTuple_Check(tup)) {
LDAPerror_TypeError("expected a tuple", tup);
LDAPerror_TypeError("Tuple_to_LDAPControl(): expected a tuple", tup);
return NULL;
}

if (!PyArg_ParseTuple( tup, "sbO", &oid, &iscritical, &bytes ))
if (!PyArg_ParseTuple( tup, "sbO:Tuple_to_LDAPControl", &oid, &iscritical, &bytes ))
return NULL;

lc = PyMem_NEW(LDAPControl, 1);
Expand Down Expand Up @@ -106,7 +106,7 @@ Tuple_to_LDAPControl( PyObject* tup )
berbytes.bv_val = PyBytes_AsString(bytes);
}
else {
LDAPerror_TypeError("expected bytes", bytes);
LDAPerror_TypeError("Tuple_to_LDAPControl(): expected bytes", bytes);
LDAPControl_DEL(lc);
return NULL;
}
Expand All @@ -128,7 +128,7 @@ LDAPControls_from_object(PyObject* list, LDAPControl ***controls_ret)
PyObject* item;

if (!PySequence_Check(list)) {
LDAPerror_TypeError("expected a list", list);
LDAPerror_TypeError("LDAPControls_from_object(): expected a list", list);
return 0;
}

Expand Down
10 changes: 8 additions & 2 deletions Tests/t_cext.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -785,10 +785,16 @@ def assertInvalidControls(self, func, *args, **kwargs):
# last two args are serverctrls, clientctrls
with self.assertRaises(TypeError) as e:
func(*(args + (object, None) + post))
self.assertEqual(e.exception.args, ('expected a list', object))
self.assertEqual(
e.exception.args,
('LDAPControls_from_object(): expected a list', object)
)
with self.assertRaises(TypeError) as e:
func(*(args + (None, object) + post))
self.assertEqual(e.exception.args, ('expected a list', object))
self.assertEqual(
e.exception.args,
('LDAPControls_from_object(): expected a list', object)
)

def test_invalid_controls(self):
l = self._open_conn()
Expand Down
48 changes: 42 additions & 6 deletions Tests/t_ldapobject.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,12 +104,48 @@ def test_reject_bytes_base(self):
base = self.server.suffix
l = self._ldap_conn

with self.assertRaises(TypeError):
l.search_s(base.encode('utf-8'), ldap.SCOPE_SUBTREE, '(cn=Foo*)', ['*'])
with self.assertRaises(TypeError):
l.search_s(base, ldap.SCOPE_SUBTREE, b'(cn=Foo*)', ['*'])
with self.assertRaises(TypeError):
l.search_s(base, ldap.SCOPE_SUBTREE, '(cn=Foo*)', [b'*'])
with self.assertRaises(TypeError) as e:
l.search_s(
base.encode('utf-8'), ldap.SCOPE_SUBTREE, '(cn=Foo*)', ['*']
)
if PY2:
self.assertIn(
u"got type 'str' for 'base'", text_type(e.exception)
)
elif sys.version_info >= (3, 5, 0):
# Python 3.4.x does not include 'search_ext()' in message
self.assertEqual(
"search_ext() argument 1 must be str, not bytes",
text_type(e.exception)
)

with self.assertRaises(TypeError) as e:
l.search_s(
base, ldap.SCOPE_SUBTREE, b'(cn=Foo*)', ['*']
)
if PY2:
self.assertIn(
u"got type 'str' for 'filterstr'", text_type(e.exception)
)
elif sys.version_info >= (3, 5, 0):
self.assertEqual(
"search_ext() argument 3 must be str, not bytes",
text_type(e.exception)
)

with self.assertRaises(TypeError) as e:
l.search_s(
base, ldap.SCOPE_SUBTREE, '(cn=Foo*)', [b'*']
)
if PY2:
self.assertIn(
u"got type 'str' for 'attrlist'", text_type(e.exception)
)
elif sys.version_info >= (3, 5, 0):
self.assertEqual(
('attrs_from_List(): expected string in list', b'*'),
e.exception.args
)

def test_search_keys_are_text(self):
base = self.server.suffix
Expand Down
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy