Skip to content

Commit c347cbe

Browse files
closes bpo-42938: Replace snprintf with Python unicode formatting in ctypes param reprs. (GH-24247)
(cherry picked from commit 916610e) Co-authored-by: Benjamin Peterson <[email protected]> Co-authored-by: Benjamin Peterson <[email protected]>
1 parent a90539f commit c347cbe

File tree

3 files changed

+64
-32
lines changed

3 files changed

+64
-32
lines changed

Lib/ctypes/test/test_parameters.py

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,49 @@ def __dict__(self):
201201
with self.assertRaises(ZeroDivisionError):
202202
WorseStruct().__setstate__({}, b'foo')
203203

204+
def test_parameter_repr(self):
205+
from ctypes import (
206+
c_bool,
207+
c_char,
208+
c_wchar,
209+
c_byte,
210+
c_ubyte,
211+
c_short,
212+
c_ushort,
213+
c_int,
214+
c_uint,
215+
c_long,
216+
c_ulong,
217+
c_longlong,
218+
c_ulonglong,
219+
c_float,
220+
c_double,
221+
c_longdouble,
222+
c_char_p,
223+
c_wchar_p,
224+
c_void_p,
225+
)
226+
self.assertRegex(repr(c_bool.from_param(True)), r"^<cparam '\?' at 0x[A-Fa-f0-9]+>$")
227+
self.assertEqual(repr(c_char.from_param(97)), "<cparam 'c' ('a')>")
228+
self.assertRegex(repr(c_wchar.from_param('a')), r"^<cparam 'u' at 0x[A-Fa-f0-9]+>$")
229+
self.assertEqual(repr(c_byte.from_param(98)), "<cparam 'b' (98)>")
230+
self.assertEqual(repr(c_ubyte.from_param(98)), "<cparam 'B' (98)>")
231+
self.assertEqual(repr(c_short.from_param(511)), "<cparam 'h' (511)>")
232+
self.assertEqual(repr(c_ushort.from_param(511)), "<cparam 'H' (511)>")
233+
self.assertRegex(repr(c_int.from_param(20000)), r"^<cparam '[li]' \(20000\)>$")
234+
self.assertRegex(repr(c_uint.from_param(20000)), r"^<cparam '[LI]' \(20000\)>$")
235+
self.assertRegex(repr(c_long.from_param(20000)), r"^<cparam '[li]' \(20000\)>$")
236+
self.assertRegex(repr(c_ulong.from_param(20000)), r"^<cparam '[LI]' \(20000\)>$")
237+
self.assertRegex(repr(c_longlong.from_param(20000)), r"^<cparam '[liq]' \(20000\)>$")
238+
self.assertRegex(repr(c_ulonglong.from_param(20000)), r"^<cparam '[LIQ]' \(20000\)>$")
239+
self.assertEqual(repr(c_float.from_param(1.5)), "<cparam 'f' (1.5)>")
240+
self.assertEqual(repr(c_double.from_param(1.5)), "<cparam 'd' (1.5)>")
241+
self.assertEqual(repr(c_double.from_param(1e300)), "<cparam 'd' (1e+300)>")
242+
self.assertRegex(repr(c_longdouble.from_param(1.5)), r"^<cparam ('d' \(1.5\)|'g' at 0x[A-Fa-f0-9]+)>$")
243+
self.assertRegex(repr(c_char_p.from_param(b'hihi')), "^<cparam 'z' \(0x[A-Fa-f0-9]+\)>$")
244+
self.assertRegex(repr(c_wchar_p.from_param('hihi')), "^<cparam 'Z' \(0x[A-Fa-f0-9]+\)>$")
245+
self.assertRegex(repr(c_void_p.from_param(0x12)), r"^<cparam 'P' \(0x0*12\)>$")
246+
204247
################################################################
205248

206249
if __name__ == '__main__':
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Avoid static buffers when computing the repr of :class:`ctypes.c_double` and
2+
:class:`ctypes.c_longdouble` values.

Modules/_ctypes/callproc.c

Lines changed: 19 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -489,58 +489,47 @@ is_literal_char(unsigned char c)
489489
static PyObject *
490490
PyCArg_repr(PyCArgObject *self)
491491
{
492-
char buffer[256];
493492
switch(self->tag) {
494493
case 'b':
495494
case 'B':
496-
sprintf(buffer, "<cparam '%c' (%d)>",
495+
return PyUnicode_FromFormat("<cparam '%c' (%d)>",
497496
self->tag, self->value.b);
498-
break;
499497
case 'h':
500498
case 'H':
501-
sprintf(buffer, "<cparam '%c' (%d)>",
499+
return PyUnicode_FromFormat("<cparam '%c' (%d)>",
502500
self->tag, self->value.h);
503-
break;
504501
case 'i':
505502
case 'I':
506-
sprintf(buffer, "<cparam '%c' (%d)>",
503+
return PyUnicode_FromFormat("<cparam '%c' (%d)>",
507504
self->tag, self->value.i);
508-
break;
509505
case 'l':
510506
case 'L':
511-
sprintf(buffer, "<cparam '%c' (%ld)>",
507+
return PyUnicode_FromFormat("<cparam '%c' (%ld)>",
512508
self->tag, self->value.l);
513-
break;
514509

515510
case 'q':
516511
case 'Q':
517-
sprintf(buffer,
518-
#ifdef MS_WIN32
519-
"<cparam '%c' (%I64d)>",
520-
#else
521-
"<cparam '%c' (%lld)>",
522-
#endif
512+
return PyUnicode_FromFormat("<cparam '%c' (%lld)>",
523513
self->tag, self->value.q);
524-
break;
525514
case 'd':
526-
sprintf(buffer, "<cparam '%c' (%f)>",
527-
self->tag, self->value.d);
528-
break;
529-
case 'f':
530-
sprintf(buffer, "<cparam '%c' (%f)>",
531-
self->tag, self->value.f);
532-
break;
533-
515+
case 'f': {
516+
PyObject *f = PyFloat_FromDouble((self->tag == 'f') ? self->value.f : self->value.d);
517+
if (f == NULL) {
518+
return NULL;
519+
}
520+
PyObject *result = PyUnicode_FromFormat("<cparam '%c' (%R)>", self->tag, f);
521+
Py_DECREF(f);
522+
return result;
523+
}
534524
case 'c':
535525
if (is_literal_char((unsigned char)self->value.c)) {
536-
sprintf(buffer, "<cparam '%c' ('%c')>",
526+
return PyUnicode_FromFormat("<cparam '%c' ('%c')>",
537527
self->tag, self->value.c);
538528
}
539529
else {
540-
sprintf(buffer, "<cparam '%c' ('\\x%02x')>",
530+
return PyUnicode_FromFormat("<cparam '%c' ('\\x%02x')>",
541531
self->tag, (unsigned char)self->value.c);
542532
}
543-
break;
544533

545534
/* Hm, are these 'z' and 'Z' codes useful at all?
546535
Shouldn't they be replaced by the functionality of c_string
@@ -549,22 +538,20 @@ PyCArg_repr(PyCArgObject *self)
549538
case 'z':
550539
case 'Z':
551540
case 'P':
552-
sprintf(buffer, "<cparam '%c' (%p)>",
541+
return PyUnicode_FromFormat("<cparam '%c' (%p)>",
553542
self->tag, self->value.p);
554543
break;
555544

556545
default:
557546
if (is_literal_char((unsigned char)self->tag)) {
558-
sprintf(buffer, "<cparam '%c' at %p>",
547+
return PyUnicode_FromFormat("<cparam '%c' at %p>",
559548
(unsigned char)self->tag, (void *)self);
560549
}
561550
else {
562-
sprintf(buffer, "<cparam 0x%02x at %p>",
551+
return PyUnicode_FromFormat("<cparam 0x%02x at %p>",
563552
(unsigned char)self->tag, (void *)self);
564553
}
565-
break;
566554
}
567-
return PyUnicode_FromString(buffer);
568555
}
569556

570557
static PyMemberDef PyCArgType_members[] = {

0 commit comments

Comments
 (0)