blob: 524ad917cd08ab5d8daeaa0404a0e61ef26ec7b5 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01005#include "pycore_tupleobject.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00006
Guido van Rossumc1d50531996-08-21 23:38:24 +00007#include <ctype.h>
Benjamin Petersona853a8b2017-09-07 11:13:59 -07008#include <float.h>
Guido van Rossumc1d50531996-08-21 23:38:24 +00009
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000010
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000012extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000014int PyArg_Parse(PyObject *, const char *, ...);
15int PyArg_ParseTuple(PyObject *, const char *, ...);
16int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000017
Tim Petersdbd9ba62000-07-09 03:09:57 +000018int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000020int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000021 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000022
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030023int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
24 struct _PyArg_Parser *, ...);
25int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
26 struct _PyArg_Parser *, va_list);
27
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000028#ifdef HAVE_DECLSPEC_DLL
29/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020030PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020031PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010032 const char *format, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020033PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs,
34 PyObject *kwnames,
Benjamin Peterson819a46f2016-09-09 20:45:06 -070035 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020036PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000037PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
38 const char *, char **, ...);
39PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020040PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000041PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
42 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070043
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030044PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
45 struct _PyArg_Parser *, ...);
46PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
47 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000048#endif
49
Martin v. Löwis18e16552006-02-15 17:27:45 +000050#define FLAG_COMPAT 1
51#define FLAG_SIZE_T 2
52
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040053typedef int (*destr_t)(PyObject *, void *);
54
55
56/* Keep track of "objects" that have been allocated or initialized and
57 which will need to be deallocated or cleaned up somehow if overall
58 parsing fails.
59*/
60typedef struct {
61 void *item;
62 destr_t destructor;
63} freelistentry_t;
64
65typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040066 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010067 int first_available;
68 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040069} freelist_t;
70
Antoine Pitrou7056cb22013-02-17 01:04:57 +010071#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072
73/* Forward */
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020074static int vgetargs1_impl(PyObject *args, PyObject *const *stack, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010075 const char *format, va_list *p_va, int flags);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000076static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020077static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020078static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
79 char *, size_t, freelist_t *);
80static const char *converttuple(PyObject *, const char **, va_list *, int,
81 int *, char *, size_t, int, freelist_t *);
82static const char *convertsimple(PyObject *, const char **, va_list *, int,
83 char *, size_t, freelist_t *);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +020084static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020085static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086
Tim Petersdbd9ba62000-07-09 03:09:57 +000087static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030089static int vgetargskeywordsfast(PyObject *, PyObject *,
90 struct _PyArg_Parser *, va_list *, int);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020091static int vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070092 PyObject *keywords, PyObject *kwnames,
93 struct _PyArg_Parser *parser,
94 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020095static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000096
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
105 va_end(va);
106 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000107}
108
Vinay Sajip0b60f642019-10-15 08:26:12 +0100109PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200110_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
121
Fred Drake563dfc22001-10-23 14:41:08 +0000122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 int retval;
126 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 va_start(va, format);
129 retval = vgetargs1(args, format, &va, 0);
130 va_end(va);
131 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000132}
133
Vinay Sajip0b60f642019-10-15 08:26:12 +0100134PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200135_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 int retval;
138 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 va_start(va, format);
141 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
142 va_end(va);
143 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000144}
145
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000146
147int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200148_PyArg_ParseStack(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100149{
150 int retval;
151 va_list va;
152
153 va_start(va, format);
154 retval = vgetargs1_impl(NULL, args, nargs, format, &va, 0);
155 va_end(va);
156 return retval;
157}
158
Vinay Sajip0b60f642019-10-15 08:26:12 +0100159PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200160_PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100161{
162 int retval;
163 va_list va;
164
165 va_start(va, format);
166 retval = vgetargs1_impl(NULL, args, nargs, format, &va, FLAG_SIZE_T);
167 va_end(va);
168 return retval;
169}
170
171
172int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000173PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200176 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000177
Benjamin Peterson0c212142016-09-20 20:39:33 -0700178 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000179
Christian Heimes2f2fee12016-09-21 11:37:27 +0200180 retval = vgetargs1(args, format, &lva, 0);
181 va_end(lva);
182 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000183}
184
Vinay Sajip0b60f642019-10-15 08:26:12 +0100185PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200186_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200189 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000190
Benjamin Peterson0c212142016-09-20 20:39:33 -0700191 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000192
Christian Heimes2f2fee12016-09-21 11:37:27 +0200193 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
194 va_end(lva);
195 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000196}
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000199/* Handle cleanup of allocated memory in case of exception */
200
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400201static int
202cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 if (ptr) {
205 PyMem_FREE(ptr);
206 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000208}
209
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000210static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400211cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000212{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400213 Py_buffer *buf = (Py_buffer *)ptr;
214 if (buf) {
215 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400217 return 0;
218}
219
220static int
221addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
222{
223 int index;
224
225 index = freelist->first_available;
226 freelist->first_available += 1;
227
228 freelist->entries[index].item = ptr;
229 freelist->entries[index].destructor = destructor;
230
231 return 0;
232}
233
234static int
235cleanreturn(int retval, freelist_t *freelist)
236{
237 int index;
238
239 if (retval == 0) {
240 /* A failure occurred, therefore execute all of the cleanup
241 functions.
242 */
243 for (index = 0; index < freelist->first_available; ++index) {
244 freelist->entries[index].destructor(NULL,
245 freelist->entries[index].item);
246 }
247 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100248 if (freelist->entries_malloced)
249 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000251}
252
253
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000254static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200255vgetargs1_impl(PyObject *compat_args, PyObject *const *stack, Py_ssize_t nargs, const char *format,
Victor Stinner6518a932017-01-17 01:29:49 +0100256 va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 char msgbuf[256];
259 int levels[32];
260 const char *fname = NULL;
261 const char *message = NULL;
262 int min = -1;
263 int max = 0;
264 int level = 0;
265 int endfmt = 0;
266 const char *formatsave = format;
Victor Stinner6518a932017-01-17 01:29:49 +0100267 Py_ssize_t i;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200268 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500270 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
271 freelist_t freelist;
272
Victor Stinner6518a932017-01-17 01:29:49 +0100273 assert(nargs == 0 || stack != NULL);
274
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500275 freelist.entries = static_entries;
276 freelist.first_available = 0;
277 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 while (endfmt == 0) {
282 int c = *format++;
283 switch (c) {
284 case '(':
285 if (level == 0)
286 max++;
287 level++;
288 if (level >= 30)
289 Py_FatalError("too many tuple nesting levels "
290 "in argument format string");
291 break;
292 case ')':
293 if (level == 0)
294 Py_FatalError("excess ')' in getargs format");
295 else
296 level--;
297 break;
298 case '\0':
299 endfmt = 1;
300 break;
301 case ':':
302 fname = format;
303 endfmt = 1;
304 break;
305 case ';':
306 message = format;
307 endfmt = 1;
308 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100309 case '|':
310 if (level == 0)
311 min = max;
312 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 default:
314 if (level == 0) {
Jordon Xu2ec70102019-09-11 00:04:08 +0800315 if (Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 if (c != 'e') /* skip encoded */
317 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
319 break;
320 }
321 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 if (level != 0)
324 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (min < 0)
327 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000330
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100331 if (max > STATIC_FREELIST_ENTRIES) {
332 freelist.entries = PyMem_NEW(freelistentry_t, max);
333 if (freelist.entries == NULL) {
334 PyErr_NoMemory();
335 return 0;
336 }
337 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500338 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 if (compat) {
341 if (max == 0) {
Victor Stinner6518a932017-01-17 01:29:49 +0100342 if (compat_args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100344 PyErr_Format(PyExc_TypeError,
345 "%.200s%s takes no arguments",
346 fname==NULL ? "function" : fname,
347 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400348 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 }
350 else if (min == 1 && max == 1) {
Victor Stinner6518a932017-01-17 01:29:49 +0100351 if (compat_args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100352 PyErr_Format(PyExc_TypeError,
353 "%.200s%s takes at least one argument",
354 fname==NULL ? "function" : fname,
355 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400356 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 }
Victor Stinner6518a932017-01-17 01:29:49 +0100358 msg = convertitem(compat_args, &format, p_va, flags, levels,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 msgbuf, sizeof(msgbuf), &freelist);
360 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400361 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400363 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 }
365 else {
366 PyErr_SetString(PyExc_SystemError,
367 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400368 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 }
370 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000371
Victor Stinner6518a932017-01-17 01:29:49 +0100372 if (nargs < min || max < nargs) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100373 if (message == NULL)
374 PyErr_Format(PyExc_TypeError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200375 "%.150s%s takes %s %d argument%s (%zd given)",
Victor Stinner6ced7c42011-03-21 18:15:42 +0100376 fname==NULL ? "function" : fname,
377 fname==NULL ? "" : "()",
378 min==max ? "exactly"
Victor Stinner6518a932017-01-17 01:29:49 +0100379 : nargs < min ? "at least" : "at most",
380 nargs < min ? min : max,
381 (nargs < min ? min : max) == 1 ? "" : "s",
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200382 nargs);
Victor Stinner6ced7c42011-03-21 18:15:42 +0100383 else
384 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400385 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000387
Victor Stinner6518a932017-01-17 01:29:49 +0100388 for (i = 0; i < nargs; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (*format == '|')
390 format++;
Victor Stinner6518a932017-01-17 01:29:49 +0100391 msg = convertitem(stack[i], &format, p_va,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 flags, levels, msgbuf,
393 sizeof(msgbuf), &freelist);
394 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200395 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400396 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 }
398 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000399
Jordon Xu2ec70102019-09-11 00:04:08 +0800400 if (*format != '\0' && !Py_ISALPHA(*format) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 *format != '(' &&
402 *format != '|' && *format != ':' && *format != ';') {
403 PyErr_Format(PyExc_SystemError,
404 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400405 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000407
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400408 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000409}
410
Victor Stinner6518a932017-01-17 01:29:49 +0100411static int
412vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
413{
414 PyObject **stack;
415 Py_ssize_t nargs;
416
417 if (!(flags & FLAG_COMPAT)) {
418 assert(args != NULL);
419
420 if (!PyTuple_Check(args)) {
421 PyErr_SetString(PyExc_SystemError,
422 "new style getargs format but argument is not a tuple");
423 return 0;
424 }
425
Victor Stinnerd17a6932018-11-09 16:56:48 +0100426 stack = _PyTuple_ITEMS(args);
Victor Stinner6518a932017-01-17 01:29:49 +0100427 nargs = PyTuple_GET_SIZE(args);
428 }
429 else {
430 stack = NULL;
431 nargs = 0;
432 }
433
434 return vgetargs1_impl(args, stack, nargs, format, p_va, flags);
435}
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000436
437
438static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200439seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000440 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 char buf[512];
443 int i;
444 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if (PyErr_Occurred())
447 return;
448 else if (message == NULL) {
449 if (fname != NULL) {
450 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
451 p += strlen(p);
452 }
453 if (iarg != 0) {
454 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100455 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 i = 0;
457 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200458 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000459 PyOS_snprintf(p, sizeof(buf) - (p - buf),
460 ", item %d", levels[i]-1);
461 p += strlen(p);
462 i++;
463 }
464 }
465 else {
466 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
467 p += strlen(p);
468 }
469 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
470 message = buf;
471 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200472 if (msg[0] == '(') {
473 PyErr_SetString(PyExc_SystemError, message);
474 }
475 else {
476 PyErr_SetString(PyExc_TypeError, message);
477 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000478}
479
480
481/* Convert a tuple argument.
482 On entry, *p_format points to the character _after_ the opening '('.
483 On successful exit, *p_format points to the closing ')'.
484 If successful:
485 *p_format and *p_va are updated,
486 *levels and *msgbuf are untouched,
487 and NULL is returned.
488 If the argument is invalid:
489 *p_format is unchanged,
490 *p_va is undefined,
491 *levels is a 0-terminated list of item numbers,
492 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 "must be <typename1>, not <typename2>", where:
494 <typename1> is the name of the expected type, and
495 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000496 and msgbuf is returned.
497*/
498
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200499static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000500converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400502 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 int level = 0;
505 int n = 0;
506 const char *format = *p_format;
507 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100508 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 for (;;) {
511 int c = *format++;
512 if (c == '(') {
513 if (level == 0)
514 n++;
515 level++;
516 }
517 else if (c == ')') {
518 if (level == 0)
519 break;
520 level--;
521 }
522 else if (c == ':' || c == ';' || c == '\0')
523 break;
Jordon Xu2ec70102019-09-11 00:04:08 +0800524 else if (level == 0 && Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 n++;
526 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
529 levels[0] = 0;
530 PyOS_snprintf(msgbuf, bufsize,
531 toplevel ? "expected %d arguments, not %.50s" :
532 "must be %d-item sequence, not %.50s",
533 n,
Victor Stinnera102ed72020-02-07 02:24:48 +0100534 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 return msgbuf;
536 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000537
Victor Stinner74387f52013-11-18 01:21:12 +0100538 len = PySequence_Size(arg);
539 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100541 if (toplevel) {
542 PyOS_snprintf(msgbuf, bufsize,
Xtreak63262782018-12-21 20:15:13 +0530543 "expected %d argument%s, not %" PY_FORMAT_SIZE_T "d",
544 n,
545 n == 1 ? "" : "s",
546 len);
Victor Stinner74387f52013-11-18 01:21:12 +0100547 }
548 else {
549 PyOS_snprintf(msgbuf, bufsize,
550 "must be sequence of length %d, "
551 "not %" PY_FORMAT_SIZE_T "d",
552 n, len);
553 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 return msgbuf;
555 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 format = *p_format;
558 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200559 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 PyObject *item;
561 item = PySequence_GetItem(arg, i);
562 if (item == NULL) {
563 PyErr_Clear();
564 levels[0] = i+1;
565 levels[1] = 0;
566 strncpy(msgbuf, "is not retrievable", bufsize);
567 return msgbuf;
568 }
569 msg = convertitem(item, &format, p_va, flags, levels+1,
570 msgbuf, bufsize, freelist);
571 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
572 Py_XDECREF(item);
573 if (msg != NULL) {
574 levels[0] = i+1;
575 return msg;
576 }
577 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 *p_format = format;
580 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000581}
582
583
584/* Convert a single item. */
585
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200586static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000587convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400588 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000589{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200590 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000593 if (*format == '(' /* ')' */) {
594 format++;
595 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
596 bufsize, 0, freelist);
597 if (msg == NULL)
598 format++;
599 }
600 else {
601 msg = convertsimple(arg, &format, p_va, flags,
602 msgbuf, bufsize, freelist);
603 if (msg != NULL)
604 levels[0] = 0;
605 }
606 if (msg == NULL)
607 *p_format = format;
608 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000609}
610
611
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000612
RĂ©mi Lapeyre4901fe22019-08-29 16:49:08 +0200613/* Format an error message generated by convertsimple().
614 displayname must be UTF-8 encoded.
615*/
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000616
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200617void
RĂ©mi Lapeyre4901fe22019-08-29 16:49:08 +0200618_PyArg_BadArgument(const char *fname, const char *displayname,
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200619 const char *expected, PyObject *arg)
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200620{
RĂ©mi Lapeyre4901fe22019-08-29 16:49:08 +0200621 PyErr_Format(PyExc_TypeError,
622 "%.200s() %.200s must be %.50s, not %.50s",
623 fname, displayname, expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100624 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200625}
626
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200627static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000628converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 assert(expected != NULL);
631 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200632 if (expected[0] == '(') {
633 PyOS_snprintf(msgbuf, bufsize,
634 "%.100s", expected);
635 }
636 else {
637 PyOS_snprintf(msgbuf, bufsize,
638 "must be %.50s, not %.50s", expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100639 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200640 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000642}
643
644#define CONV_UNICODE "(unicode conversion error)"
645
646/* Convert a non-tuple argument. Return NULL if conversion went OK,
647 or a string with a message describing the failure. The message is
648 formatted as "must be <desired type>, not <actual type>".
649 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000650 Don't call if a tuple is expected.
651
652 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000653*/
654
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200655static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000656convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400657 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 /* For # codes */
660#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
661 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
Inada Naokid3c72a22019-03-23 21:04:40 +0900662 else { \
663 if (PyErr_WarnEx(PyExc_DeprecationWarning, \
664 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) { \
665 return NULL; \
666 } \
667 q=va_arg(*p_va, int*); \
668 }
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000669#define STORE_SIZE(s) \
670 if (flags & FLAG_SIZE_T) \
671 *q2=s; \
672 else { \
673 if (INT_MAX < s) { \
674 PyErr_SetString(PyExc_OverflowError, \
675 "size does not fit in an int"); \
676 return converterr("", arg, msgbuf, bufsize); \
677 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200678 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000679 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000680#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000681#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000682
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000683 const char *format = *p_format;
684 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200685 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000689 case 'b': { /* unsigned byte -- very short int */
690 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300691 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000692 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000693 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000694 else if (ival < 0) {
695 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000696 "unsigned byte integer is less than minimum");
697 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000698 }
699 else if (ival > UCHAR_MAX) {
700 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000701 "unsigned byte integer is greater than maximum");
702 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 }
704 else
705 *p = (unsigned char) ival;
706 break;
707 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 case 'B': {/* byte sized bitfield - both signed and unsigned
710 values allowed */
711 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300712 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
713 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000714 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000715 else
716 *p = (unsigned char) ival;
717 break;
718 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000719
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000720 case 'h': {/* signed short int */
721 short *p = va_arg(*p_va, short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300722 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000724 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000725 else if (ival < SHRT_MIN) {
726 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000727 "signed short integer is less than minimum");
728 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000729 }
730 else if (ival > SHRT_MAX) {
731 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000732 "signed short integer is greater than maximum");
733 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 }
735 else
736 *p = (short) ival;
737 break;
738 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000739
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 case 'H': { /* short int sized bitfield, both signed and
741 unsigned allowed */
742 unsigned short *p = va_arg(*p_va, unsigned short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300743 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
744 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000745 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000746 else
747 *p = (unsigned short) ival;
748 break;
749 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000750
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000751 case 'i': {/* signed int */
752 int *p = va_arg(*p_va, int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300753 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000755 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000756 else if (ival > INT_MAX) {
757 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000758 "signed integer is greater than maximum");
759 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 }
761 else if (ival < INT_MIN) {
762 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000763 "signed integer is less than minimum");
764 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 }
766 else
767 *p = ival;
768 break;
769 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 case 'I': { /* int sized bitfield, both signed and
772 unsigned allowed */
773 unsigned int *p = va_arg(*p_va, unsigned int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300774 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
775 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000776 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 else
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300778 *p = (unsigned int) ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 break;
780 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000781
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000782 case 'n': /* Py_ssize_t */
783 {
784 PyObject *iobj;
785 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
786 Py_ssize_t ival = -1;
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300787 iobj = _PyNumber_Index(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000788 if (iobj != NULL) {
789 ival = PyLong_AsSsize_t(iobj);
790 Py_DECREF(iobj);
791 }
792 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000793 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000794 *p = ival;
795 break;
796 }
797 case 'l': {/* long int */
798 long *p = va_arg(*p_va, long *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300799 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000800 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000801 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 else
803 *p = ival;
804 break;
805 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000806
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000807 case 'k': { /* long sized bitfield */
808 unsigned long *p = va_arg(*p_va, unsigned long *);
809 unsigned long ival;
810 if (PyLong_Check(arg))
811 ival = PyLong_AsUnsignedLongMask(arg);
812 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200813 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 *p = ival;
815 break;
816 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000817
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700818 case 'L': {/* long long */
819 long long *p = va_arg( *p_va, long long * );
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300820 long long ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700821 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000822 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000823 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000825 break;
826 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000827
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700829 unsigned long long *p = va_arg(*p_va, unsigned long long *);
830 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000831 if (PyLong_Check(arg))
832 ival = PyLong_AsUnsignedLongLongMask(arg);
833 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200834 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000835 *p = ival;
836 break;
837 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000838
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000839 case 'f': {/* float */
840 float *p = va_arg(*p_va, float *);
841 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700842 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000843 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 else
845 *p = (float) dval;
846 break;
847 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000848
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 case 'd': {/* double */
850 double *p = va_arg(*p_va, double *);
851 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700852 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000853 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 else
855 *p = dval;
856 break;
857 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 case 'D': {/* complex double */
860 Py_complex *p = va_arg(*p_va, Py_complex *);
861 Py_complex cval;
862 cval = PyComplex_AsCComplex(arg);
863 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000864 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 else
866 *p = cval;
867 break;
868 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 case 'c': {/* char */
871 char *p = va_arg(*p_va, char *);
872 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
873 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300874 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
875 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 else
877 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
878 break;
879 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 case 'C': {/* unicode char */
882 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200883 int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +0300884 const void *data;
Victor Stinnere1335c72011-10-04 20:53:03 +0200885
886 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200888
889 if (PyUnicode_READY(arg))
890 RETURN_ERR_OCCURRED;
891
892 if (PyUnicode_GET_LENGTH(arg) != 1)
893 return converterr("a unicode character", arg, msgbuf, bufsize);
894
895 kind = PyUnicode_KIND(arg);
896 data = PyUnicode_DATA(arg);
897 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 break;
899 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000900
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700901 case 'p': {/* boolean *p*redicate */
902 int *p = va_arg(*p_va, int *);
903 int val = PyObject_IsTrue(arg);
904 if (val > 0)
905 *p = 1;
906 else if (val == 0)
907 *p = 0;
908 else
909 RETURN_ERR_OCCURRED;
910 break;
911 }
912
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000913 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000914 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000915
Serhiy Storchakab757c832014-12-05 22:25:22 +0200916 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000917 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200918 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000919 Py_ssize_t count;
920 if (*format == '*') {
921 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
922 return converterr(buf, arg, msgbuf, bufsize);
923 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400924 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000925 return converterr(
926 "(cleanup problem)",
927 arg, msgbuf, bufsize);
928 }
929 break;
930 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200931 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000932 if (count < 0)
933 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000934 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 FETCH_SIZE;
936 STORE_SIZE(count);
937 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000938 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300939 if (strlen(*p) != (size_t)count) {
940 PyErr_SetString(PyExc_ValueError, "embedded null byte");
941 RETURN_ERR_OCCURRED;
942 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000943 }
944 break;
945 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000946
Serhiy Storchakab757c832014-12-05 22:25:22 +0200947 case 's': /* text string or bytes-like object */
948 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000949 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000950 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000951 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000952 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000953
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000954 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
956 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200957 Py_ssize_t len;
958 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
959 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000960 return converterr(CONV_UNICODE,
961 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200962 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000963 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200964 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200965 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000966 if (getbuffer(arg, p, &buf) < 0)
967 return converterr(buf, arg, msgbuf, bufsize);
968 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400969 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000970 return converterr(
971 "(cleanup problem)",
972 arg, msgbuf, bufsize);
973 }
974 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200975 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000976 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200977 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000979
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000980 if (c == 'z' && arg == Py_None) {
981 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 STORE_SIZE(0);
983 }
984 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200985 Py_ssize_t len;
986 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
987 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000988 return converterr(CONV_UNICODE,
989 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200990 *p = sarg;
991 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200993 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200995 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 Py_ssize_t count = convertbuffer(arg, p, &buf);
997 if (count < 0)
998 return converterr(buf, arg, msgbuf, bufsize);
999 STORE_SIZE(count);
1000 }
1001 format++;
1002 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001003 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001004 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001005 Py_ssize_t len;
1006 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001007
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001008 if (c == 'z' && arg == Py_None)
1009 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001011 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1012 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001013 return converterr(CONV_UNICODE,
1014 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001015 if (strlen(sarg) != (size_t)len) {
1016 PyErr_SetString(PyExc_ValueError, "embedded null character");
1017 RETURN_ERR_OCCURRED;
1018 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001019 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 }
1021 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001022 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 }
1025 break;
1026 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001027
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001028 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1029 case 'Z': /* raw unicode buffer or None */
1030 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001031 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1032
Serhiy Storchakab757c832014-12-05 22:25:22 +02001033 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001034 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001035 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001036
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001037 if (c == 'Z' && arg == Py_None) {
1038 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001039 STORE_SIZE(0);
1040 }
1041 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001042 Py_ssize_t len;
1043 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001044 if (*p == NULL)
1045 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001046 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001047 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001048 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001049 return converterr(c == 'Z' ? "str or None" : "str",
1050 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001051 format++;
1052 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001053 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001054 if (c == 'Z' && arg == Py_None)
1055 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001056 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001057 Py_ssize_t len;
1058 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001059 if (*p == NULL)
1060 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001061 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001062 PyErr_SetString(PyExc_ValueError, "embedded null character");
1063 RETURN_ERR_OCCURRED;
1064 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001065 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001066 return converterr(c == 'Z' ? "str or None" : "str",
1067 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 }
1069 break;
1070 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001071
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 case 'e': {/* encoded string */
1073 char **buffer;
1074 const char *encoding;
1075 PyObject *s;
1076 int recode_strings;
1077 Py_ssize_t size;
1078 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001079
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 /* Get 'e' parameter: the encoding name */
1081 encoding = (const char *)va_arg(*p_va, const char *);
1082 if (encoding == NULL)
1083 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001084
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 /* Get output buffer parameter:
1086 's' (recode all objects via Unicode) or
1087 't' (only recode non-string objects)
1088 */
1089 if (*format == 's')
1090 recode_strings = 1;
1091 else if (*format == 't')
1092 recode_strings = 0;
1093 else
1094 return converterr(
1095 "(unknown parser marker combination)",
1096 arg, msgbuf, bufsize);
1097 buffer = (char **)va_arg(*p_va, char **);
1098 format++;
1099 if (buffer == NULL)
1100 return converterr("(buffer is NULL)",
1101 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001103 /* Encode object */
1104 if (!recode_strings &&
1105 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1106 s = arg;
1107 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001108 if (PyBytes_Check(arg)) {
1109 size = PyBytes_GET_SIZE(s);
1110 ptr = PyBytes_AS_STRING(s);
1111 }
1112 else {
1113 size = PyByteArray_GET_SIZE(s);
1114 ptr = PyByteArray_AS_STRING(s);
1115 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001117 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001119 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 encoding,
1121 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 if (s == NULL)
1123 return converterr("(encoding failed)",
1124 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001125 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 size = PyBytes_GET_SIZE(s);
1127 ptr = PyBytes_AS_STRING(s);
1128 if (ptr == NULL)
1129 ptr = "";
1130 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001131 else {
1132 return converterr(
1133 recode_strings ? "str" : "str, bytes or bytearray",
1134 arg, msgbuf, bufsize);
1135 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001136
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001137 /* Write output; output is guaranteed to be 0-terminated */
1138 if (*format == '#') {
1139 /* Using buffer length parameter '#':
1140
1141 - if *buffer is NULL, a new buffer of the
1142 needed size is allocated and the data
1143 copied into it; *buffer is updated to point
1144 to the new buffer; the caller is
1145 responsible for PyMem_Free()ing it after
1146 usage
1147
1148 - if *buffer is not NULL, the data is
1149 copied to *buffer; *buffer_len has to be
1150 set to the size of the buffer on input;
1151 buffer overflow is signalled with an error;
1152 buffer has to provide enough room for the
1153 encoded string plus the trailing 0-byte
1154
1155 - in both cases, *buffer_len is updated to
1156 the size of the buffer /excluding/ the
1157 trailing 0-byte
1158
1159 */
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001160 int *q = NULL; Py_ssize_t *q2 = NULL;
1161 if (flags & FLAG_SIZE_T) {
1162 q2 = va_arg(*p_va, Py_ssize_t*);
1163 }
1164 else {
1165 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1166 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1))
1167 {
1168 Py_DECREF(s);
1169 return NULL;
1170 }
1171 q = va_arg(*p_va, int*);
1172 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001173
1174 format++;
1175 if (q == NULL && q2 == NULL) {
1176 Py_DECREF(s);
1177 return converterr(
1178 "(buffer_len is NULL)",
1179 arg, msgbuf, bufsize);
1180 }
1181 if (*buffer == NULL) {
1182 *buffer = PyMem_NEW(char, size + 1);
1183 if (*buffer == NULL) {
1184 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001185 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001186 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001188 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 Py_DECREF(s);
1190 return converterr(
1191 "(cleanup problem)",
1192 arg, msgbuf, bufsize);
1193 }
1194 } else {
1195 if (size + 1 > BUFFER_LEN) {
1196 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001197 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001198 "encoded string too long "
1199 "(%zd, maximum length %zd)",
1200 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1201 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001202 }
1203 }
1204 memcpy(*buffer, ptr, size+1);
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001205
1206 if (flags & FLAG_SIZE_T) {
1207 *q2 = size;
1208 }
1209 else {
1210 if (INT_MAX < size) {
1211 Py_DECREF(s);
1212 PyErr_SetString(PyExc_OverflowError,
1213 "size does not fit in an int");
1214 return converterr("", arg, msgbuf, bufsize);
1215 }
1216 *q = (int)size;
1217 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001218 } else {
1219 /* Using a 0-terminated buffer:
1220
1221 - the encoded string has to be 0-terminated
1222 for this variant to work; if it is not, an
1223 error raised
1224
1225 - a new buffer of the needed size is
1226 allocated and the data copied into it;
1227 *buffer is updated to point to the new
1228 buffer; the caller is responsible for
1229 PyMem_Free()ing it after usage
1230
1231 */
1232 if ((Py_ssize_t)strlen(ptr) != size) {
1233 Py_DECREF(s);
1234 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001235 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001236 arg, msgbuf, bufsize);
1237 }
1238 *buffer = PyMem_NEW(char, size + 1);
1239 if (*buffer == NULL) {
1240 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001241 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001242 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001243 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001244 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001245 Py_DECREF(s);
1246 return converterr("(cleanup problem)",
1247 arg, msgbuf, bufsize);
1248 }
1249 memcpy(*buffer, ptr, size+1);
1250 }
1251 Py_DECREF(s);
1252 break;
1253 }
1254
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001255 case 'S': { /* PyBytes object */
1256 PyObject **p = va_arg(*p_va, PyObject **);
1257 if (PyBytes_Check(arg))
1258 *p = arg;
1259 else
1260 return converterr("bytes", arg, msgbuf, bufsize);
1261 break;
1262 }
1263
1264 case 'Y': { /* PyByteArray object */
1265 PyObject **p = va_arg(*p_va, PyObject **);
1266 if (PyByteArray_Check(arg))
1267 *p = arg;
1268 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001269 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001270 break;
1271 }
1272
1273 case 'U': { /* PyUnicode object */
1274 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001275 if (PyUnicode_Check(arg)) {
1276 if (PyUnicode_READY(arg) == -1)
1277 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001278 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001279 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001280 else
1281 return converterr("str", arg, msgbuf, bufsize);
1282 break;
1283 }
1284
1285 case 'O': { /* object */
1286 PyTypeObject *type;
1287 PyObject **p;
1288 if (*format == '!') {
1289 type = va_arg(*p_va, PyTypeObject*);
1290 p = va_arg(*p_va, PyObject **);
1291 format++;
Victor Stinnera102ed72020-02-07 02:24:48 +01001292 if (PyType_IsSubtype(Py_TYPE(arg), type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001293 *p = arg;
1294 else
1295 return converterr(type->tp_name, arg, msgbuf, bufsize);
1296
1297 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 else if (*format == '&') {
1299 typedef int (*converter)(PyObject *, void *);
1300 converter convert = va_arg(*p_va, converter);
1301 void *addr = va_arg(*p_va, void *);
1302 int res;
1303 format++;
1304 if (! (res = (*convert)(arg, addr)))
1305 return converterr("(unspecified)",
1306 arg, msgbuf, bufsize);
1307 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001308 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001309 return converterr("(cleanup problem)",
1310 arg, msgbuf, bufsize);
1311 }
1312 else {
1313 p = va_arg(*p_va, PyObject **);
1314 *p = arg;
1315 }
1316 break;
1317 }
1318
1319
Victor Stinner25e8ec42010-06-25 00:02:38 +00001320 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322
Victor Stinner25e8ec42010-06-25 00:02:38 +00001323 if (*format != '*')
1324 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001325 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001326 arg, msgbuf, bufsize);
1327 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001328
Victor Stinner25e8ec42010-06-25 00:02:38 +00001329 /* Caller is interested in Py_buffer, and the object
1330 supports it directly. */
1331 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1332 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001333 return converterr("read-write bytes-like object",
1334 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001335 }
Victor Stinner8182b712010-07-28 00:40:58 +00001336 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1337 PyBuffer_Release((Py_buffer*)p);
1338 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1339 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001340 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001341 return converterr(
1342 "(cleanup problem)",
1343 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 break;
1346 }
1347
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001349 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001350
1351 }
1352
1353 *p_format = format;
1354 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001355
1356#undef FETCH_SIZE
1357#undef STORE_SIZE
1358#undef BUFFER_LEN
1359#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001360}
Guido van Rossumaa354651996-08-19 19:32:04 +00001361
Martin v. Löwis18e16552006-02-15 17:27:45 +00001362static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001363convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001364{
Victor Stinner5cb62392010-06-06 20:27:51 +00001365 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 Py_ssize_t count;
1367 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001368
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 *errmsg = NULL;
1370 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001371 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001372 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 return -1;
1374 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001375
Victor Stinner8182b712010-07-28 00:40:58 +00001376 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001378 count = view.len;
1379 *p = view.buf;
1380 PyBuffer_Release(&view);
1381 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001382}
Guido van Rossumaa354651996-08-19 19:32:04 +00001383
Martin v. Löwis423be952008-08-13 15:53:07 +00001384static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001385getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001386{
Victor Stinner8182b712010-07-28 00:40:58 +00001387 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001388 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 return -1;
1390 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001391 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001392 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001393 *errmsg = "contiguous buffer";
1394 return -1;
1395 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001397}
1398
Guido van Rossumaa354651996-08-19 19:32:04 +00001399/* Support for keyword arguments donated by
1400 Geoff Philbrick <philbric@delphi.hks.com> */
1401
Tim Petersf8cd3e82001-10-27 04:26:57 +00001402/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001403int
1404PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001405 PyObject *keywords,
1406 const char *format,
1407 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001408{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001409 int retval;
1410 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001411
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 if ((args == NULL || !PyTuple_Check(args)) ||
1413 (keywords != NULL && !PyDict_Check(keywords)) ||
1414 format == NULL ||
1415 kwlist == NULL)
1416 {
1417 PyErr_BadInternalCall();
1418 return 0;
1419 }
Tim Peters45772cd2001-10-27 03:58:40 +00001420
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 va_start(va, kwlist);
1422 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1423 va_end(va);
1424 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001425}
1426
Vinay Sajip0b60f642019-10-15 08:26:12 +01001427PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001428_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 PyObject *keywords,
1430 const char *format,
1431 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 int retval;
1434 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001435
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 if ((args == NULL || !PyTuple_Check(args)) ||
1437 (keywords != NULL && !PyDict_Check(keywords)) ||
1438 format == NULL ||
1439 kwlist == NULL)
1440 {
1441 PyErr_BadInternalCall();
1442 return 0;
1443 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 va_start(va, kwlist);
1446 retval = vgetargskeywords(args, keywords, format,
1447 kwlist, &va, FLAG_SIZE_T);
1448 va_end(va);
1449 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001450}
1451
1452
Brett Cannon711e7d92004-07-10 22:20:32 +00001453int
1454PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001455 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001456 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001457 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001458{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001459 int retval;
1460 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001461
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 if ((args == NULL || !PyTuple_Check(args)) ||
1463 (keywords != NULL && !PyDict_Check(keywords)) ||
1464 format == NULL ||
1465 kwlist == NULL)
1466 {
1467 PyErr_BadInternalCall();
1468 return 0;
1469 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001470
Benjamin Peterson0c212142016-09-20 20:39:33 -07001471 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001472
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001474 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001476}
1477
Vinay Sajip0b60f642019-10-15 08:26:12 +01001478PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001479_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 PyObject *keywords,
1481 const char *format,
1482 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001483{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001484 int retval;
1485 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001486
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 if ((args == NULL || !PyTuple_Check(args)) ||
1488 (keywords != NULL && !PyDict_Check(keywords)) ||
1489 format == NULL ||
1490 kwlist == NULL)
1491 {
1492 PyErr_BadInternalCall();
1493 return 0;
1494 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001495
Benjamin Peterson0c212142016-09-20 20:39:33 -07001496 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001497
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 retval = vgetargskeywords(args, keywords, format,
1499 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001500 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001502}
1503
Vinay Sajip0b60f642019-10-15 08:26:12 +01001504PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001505_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1506 struct _PyArg_Parser *parser, ...)
1507{
1508 int retval;
1509 va_list va;
1510
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001511 va_start(va, parser);
1512 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1513 va_end(va);
1514 return retval;
1515}
1516
Vinay Sajip0b60f642019-10-15 08:26:12 +01001517PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001518_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1519 struct _PyArg_Parser *parser, ...)
1520{
1521 int retval;
1522 va_list va;
1523
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001524 va_start(va, parser);
1525 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1526 va_end(va);
1527 return retval;
1528}
1529
Vinay Sajip0b60f642019-10-15 08:26:12 +01001530PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001531_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001532 struct _PyArg_Parser *parser, ...)
1533{
1534 int retval;
1535 va_list va;
1536
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001537 va_start(va, parser);
1538 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1539 va_end(va);
1540 return retval;
1541}
1542
Vinay Sajip0b60f642019-10-15 08:26:12 +01001543PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001544_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001545 struct _PyArg_Parser *parser, ...)
1546{
1547 int retval;
1548 va_list va;
1549
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001550 va_start(va, parser);
1551 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1552 va_end(va);
1553 return retval;
1554}
1555
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001556
Vinay Sajip0b60f642019-10-15 08:26:12 +01001557PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001558_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1559 struct _PyArg_Parser *parser, va_list va)
1560{
1561 int retval;
1562 va_list lva;
1563
Benjamin Peterson0c212142016-09-20 20:39:33 -07001564 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001565
1566 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001567 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001568 return retval;
1569}
1570
Vinay Sajip0b60f642019-10-15 08:26:12 +01001571PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001572_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1573 struct _PyArg_Parser *parser, va_list va)
1574{
1575 int retval;
1576 va_list lva;
1577
Benjamin Peterson0c212142016-09-20 20:39:33 -07001578 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001579
1580 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001581 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001582 return retval;
1583}
1584
1585int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001586PyArg_ValidateKeywordArguments(PyObject *kwargs)
1587{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001588 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 PyErr_BadInternalCall();
1590 return 0;
1591 }
1592 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1593 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001594 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001595 return 0;
1596 }
1597 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001598}
1599
Christian Heimes380f7f22008-02-28 11:19:05 +00001600#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001601
Guido van Rossumaa354651996-08-19 19:32:04 +00001602static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001603vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001604 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001605{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 char msgbuf[512];
1607 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001608 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001610 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001611 int i, pos, len;
1612 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001613 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001614 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001615 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001616 freelist_t freelist;
1617
1618 freelist.entries = static_entries;
1619 freelist.first_available = 0;
1620 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001621
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001623 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 assert(format != NULL);
1625 assert(kwlist != NULL);
1626 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 /* grab the function name or custom error msg first (mutually exclusive) */
1629 fname = strchr(format, ':');
1630 if (fname) {
1631 fname++;
1632 custom_msg = NULL;
1633 }
1634 else {
1635 custom_msg = strchr(format,';');
1636 if (custom_msg)
1637 custom_msg++;
1638 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001639
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001640 /* scan kwlist and count the number of positional-only parameters */
1641 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1642 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001644 for (len = pos; kwlist[len]; len++) {
1645 if (!*kwlist[len]) {
1646 PyErr_SetString(PyExc_SystemError,
1647 "Empty keyword parameter name");
1648 return cleanreturn(0, &freelist);
1649 }
1650 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001651
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001652 if (len > STATIC_FREELIST_ENTRIES) {
1653 freelist.entries = PyMem_NEW(freelistentry_t, len);
1654 if (freelist.entries == NULL) {
1655 PyErr_NoMemory();
1656 return 0;
1657 }
1658 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001659 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001660
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001662 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1663 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001664 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1665 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001666 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001667 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 (fname == NULL) ? "function" : fname,
1669 (fname == NULL) ? "" : "()",
1670 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001671 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001672 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001673 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001674 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 }
Tim Petersc2f01122001-10-27 07:25:06 +00001676
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001677 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1678 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001680 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001681 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001682 "Invalid format string (| specified twice)");
1683 return cleanreturn(0, &freelist);
1684 }
1685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 min = i;
1687 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001688
1689 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001690 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001691 "Invalid format string ($ before |)");
1692 return cleanreturn(0, &freelist);
1693 }
1694 }
1695 if (*format == '$') {
1696 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001697 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001698 "Invalid format string ($ specified twice)");
1699 return cleanreturn(0, &freelist);
1700 }
1701
1702 max = i;
1703 format++;
1704
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001705 if (max < pos) {
1706 PyErr_SetString(PyExc_SystemError,
1707 "Empty parameter name after $");
1708 return cleanreturn(0, &freelist);
1709 }
1710 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001711 /* Now we know the minimal and the maximal numbers of
1712 * positional arguments and can raise an exception with
1713 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001714 break;
1715 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001716 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001717 if (max == 0) {
1718 PyErr_Format(PyExc_TypeError,
1719 "%.200s%s takes no positional arguments",
1720 (fname == NULL) ? "function" : fname,
1721 (fname == NULL) ? "" : "()");
1722 }
1723 else {
1724 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301725 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001726 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001727 (fname == NULL) ? "function" : fname,
1728 (fname == NULL) ? "" : "()",
1729 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301730 max,
1731 max == 1 ? "" : "s",
1732 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001733 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001734 return cleanreturn(0, &freelist);
1735 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 }
1737 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001738 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 "More keyword list entries (%d) than "
1740 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001741 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001743 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001744 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001745 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001746 }
1747 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001748 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1749 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001750 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001751 }
1752 else if (PyErr_Occurred()) {
1753 return cleanreturn(0, &freelist);
1754 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001755 }
1756 else {
1757 current_arg = NULL;
1758 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001759
1760 if (current_arg) {
1761 msg = convertitem(current_arg, &format, p_va, flags,
1762 levels, msgbuf, sizeof(msgbuf), &freelist);
1763 if (msg) {
1764 seterror(i+1, msg, levels, fname, custom_msg);
1765 return cleanreturn(0, &freelist);
1766 }
1767 continue;
1768 }
1769
1770 if (i < min) {
1771 if (i < pos) {
1772 assert (min == INT_MAX);
1773 assert (max == INT_MAX);
1774 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001775 /* At that moment we still don't know the minimal and
1776 * the maximal numbers of positional arguments. Raising
1777 * an exception is deferred until we encounter | and $
1778 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001779 }
1780 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001781 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1782 "argument '%s' (pos %d)",
1783 (fname == NULL) ? "function" : fname,
1784 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001785 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001786 return cleanreturn(0, &freelist);
1787 }
1788 }
1789 /* current code reports success when all required args
1790 * fulfilled and no keyword args left, with no further
1791 * validation. XXX Maybe skip this in debug build ?
1792 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001793 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001794 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001795 }
1796 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001797
Leo Ariasc3d95082018-02-03 18:36:10 -06001798 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001799 * keyword args */
1800 msg = skipitem(&format, p_va, flags);
1801 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001802 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001803 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001804 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001805 }
1806 }
Tim Petersb054be42001-10-27 05:07:41 +00001807
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001808 if (skip) {
1809 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301810 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001811 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001812 (fname == NULL) ? "function" : fname,
1813 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001814 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301815 Py_MIN(pos, min),
1816 Py_MIN(pos, min) == 1 ? "" : "s",
1817 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001818 return cleanreturn(0, &freelist);
1819 }
1820
Larry Hastings83a9f482012-03-20 20:06:16 +00001821 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001822 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 "more argument specifiers than keyword list entries "
1824 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001825 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 }
Tim Petersc2f01122001-10-27 07:25:06 +00001827
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001828 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001829 PyObject *key;
1830 Py_ssize_t j;
1831 /* make sure there are no arguments given by name and position */
1832 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001833 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001834 if (current_arg) {
1835 /* arg present in tuple and in dict */
1836 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001837 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001838 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001839 (fname == NULL) ? "function" : fname,
1840 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001841 kwlist[i], i+1);
1842 return cleanreturn(0, &freelist);
1843 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001844 else if (PyErr_Occurred()) {
1845 return cleanreturn(0, &freelist);
1846 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001847 }
1848 /* make sure there are no extraneous keyword arguments */
1849 j = 0;
1850 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001851 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001852 if (!PyUnicode_Check(key)) {
1853 PyErr_SetString(PyExc_TypeError,
1854 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001855 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001856 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001857 for (i = pos; i < len; i++) {
1858 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001859 match = 1;
1860 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001861 }
1862 }
1863 if (!match) {
1864 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001865 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001866 "argument for %.200s%s",
1867 key,
1868 (fname == NULL) ? "this function" : fname,
1869 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001870 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 }
1872 }
1873 }
1874
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001875 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001876}
1877
1878
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001879/* List of static parsers. */
1880static struct _PyArg_Parser *static_arg_parsers = NULL;
1881
1882static int
1883parser_init(struct _PyArg_Parser *parser)
1884{
1885 const char * const *keywords;
1886 const char *format, *msg;
1887 int i, len, min, max, nkw;
1888 PyObject *kwtuple;
1889
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001890 assert(parser->keywords != NULL);
1891 if (parser->kwtuple != NULL) {
1892 return 1;
1893 }
1894
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001895 keywords = parser->keywords;
1896 /* scan keywords and count the number of positional-only parameters */
1897 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1898 }
1899 parser->pos = i;
1900 /* scan keywords and get greatest possible nbr of args */
1901 for (; keywords[i]; i++) {
1902 if (!*keywords[i]) {
1903 PyErr_SetString(PyExc_SystemError,
1904 "Empty keyword parameter name");
1905 return 0;
1906 }
1907 }
1908 len = i;
1909
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001910 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001911 if (format) {
1912 /* grab the function name or custom error msg first (mutually exclusive) */
1913 parser->fname = strchr(parser->format, ':');
1914 if (parser->fname) {
1915 parser->fname++;
1916 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001917 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001918 else {
1919 parser->custom_msg = strchr(parser->format,';');
1920 if (parser->custom_msg)
1921 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001922 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001923
1924 min = max = INT_MAX;
1925 for (i = 0; i < len; i++) {
1926 if (*format == '|') {
1927 if (min != INT_MAX) {
1928 PyErr_SetString(PyExc_SystemError,
1929 "Invalid format string (| specified twice)");
1930 return 0;
1931 }
1932 if (max != INT_MAX) {
1933 PyErr_SetString(PyExc_SystemError,
1934 "Invalid format string ($ before |)");
1935 return 0;
1936 }
1937 min = i;
1938 format++;
1939 }
1940 if (*format == '$') {
1941 if (max != INT_MAX) {
1942 PyErr_SetString(PyExc_SystemError,
1943 "Invalid format string ($ specified twice)");
1944 return 0;
1945 }
1946 if (i < parser->pos) {
1947 PyErr_SetString(PyExc_SystemError,
1948 "Empty parameter name after $");
1949 return 0;
1950 }
1951 max = i;
1952 format++;
1953 }
1954 if (IS_END_OF_FORMAT(*format)) {
1955 PyErr_Format(PyExc_SystemError,
1956 "More keyword list entries (%d) than "
1957 "format specifiers (%d)", len, i);
1958 return 0;
1959 }
1960
1961 msg = skipitem(&format, NULL, 0);
1962 if (msg) {
1963 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1964 format);
1965 return 0;
1966 }
1967 }
1968 parser->min = Py_MIN(min, len);
1969 parser->max = Py_MIN(max, len);
1970
1971 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001972 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02001973 "more argument specifiers than keyword list entries "
1974 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001975 return 0;
1976 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001977 }
1978
1979 nkw = len - parser->pos;
1980 kwtuple = PyTuple_New(nkw);
1981 if (kwtuple == NULL) {
1982 return 0;
1983 }
1984 keywords = parser->keywords + parser->pos;
1985 for (i = 0; i < nkw; i++) {
1986 PyObject *str = PyUnicode_FromString(keywords[i]);
1987 if (str == NULL) {
1988 Py_DECREF(kwtuple);
1989 return 0;
1990 }
1991 PyUnicode_InternInPlace(&str);
1992 PyTuple_SET_ITEM(kwtuple, i, str);
1993 }
1994 parser->kwtuple = kwtuple;
1995
1996 assert(parser->next == NULL);
1997 parser->next = static_arg_parsers;
1998 static_arg_parsers = parser;
1999 return 1;
2000}
2001
2002static void
2003parser_clear(struct _PyArg_Parser *parser)
2004{
2005 Py_CLEAR(parser->kwtuple);
2006}
2007
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002008static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002009find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002010{
2011 Py_ssize_t i, nkwargs;
2012
2013 nkwargs = PyTuple_GET_SIZE(kwnames);
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002014 for (i = 0; i < nkwargs; i++) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002015 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2016
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002017 /* kwname == key will normally find a match in since keyword keys
2018 should be interned strings; if not retry below in a new loop. */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002019 if (kwname == key) {
2020 return kwstack[i];
2021 }
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002022 }
2023
2024 for (i = 0; i < nkwargs; i++) {
2025 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
Jeroen Demeyer05677862019-08-16 12:41:27 +02002026 assert(PyUnicode_Check(kwname));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002027 if (_PyUnicode_EQ(kwname, key)) {
2028 return kwstack[i];
2029 }
2030 }
2031 return NULL;
2032}
2033
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002034static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002035vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002036 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002037 struct _PyArg_Parser *parser,
2038 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002039{
2040 PyObject *kwtuple;
2041 char msgbuf[512];
2042 int levels[32];
2043 const char *format;
2044 const char *msg;
2045 PyObject *keyword;
2046 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002047 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002048 PyObject *current_arg;
2049 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2050 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002051 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002052
2053 freelist.entries = static_entries;
2054 freelist.first_available = 0;
2055 freelist.entries_malloced = 0;
2056
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002057 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002058 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002059 assert(p_va != NULL);
2060
Victor Stinner80ab22f2017-01-16 23:16:47 +01002061 if (parser == NULL) {
2062 PyErr_BadInternalCall();
2063 return 0;
2064 }
2065
2066 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2067 PyErr_BadInternalCall();
2068 return 0;
2069 }
2070
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002071 if (!parser_init(parser)) {
2072 return 0;
2073 }
2074
2075 kwtuple = parser->kwtuple;
2076 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002077 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002078
2079 if (len > STATIC_FREELIST_ENTRIES) {
2080 freelist.entries = PyMem_NEW(freelistentry_t, len);
2081 if (freelist.entries == NULL) {
2082 PyErr_NoMemory();
2083 return 0;
2084 }
2085 freelist.entries_malloced = 1;
2086 }
2087
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002088 if (kwargs != NULL) {
2089 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002090 }
2091 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002092 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002093 kwstack = args + nargs;
2094 }
2095 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002096 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002097 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002098 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002099 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2100 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002101 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002102 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002103 (parser->fname == NULL) ? "function" : parser->fname,
2104 (parser->fname == NULL) ? "" : "()",
2105 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002106 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002107 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002108 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002109 return cleanreturn(0, &freelist);
2110 }
2111 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002112 if (parser->max == 0) {
2113 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002114 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002115 (parser->fname == NULL) ? "function" : parser->fname,
2116 (parser->fname == NULL) ? "" : "()");
2117 }
2118 else {
2119 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002120 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002121 (parser->fname == NULL) ? "function" : parser->fname,
2122 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002123 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302124 parser->max,
2125 parser->max == 1 ? "" : "s",
2126 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002127 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002128 return cleanreturn(0, &freelist);
2129 }
2130
2131 format = parser->format;
2132 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2133 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002134 if (*format == '|') {
2135 format++;
2136 }
2137 if (*format == '$') {
2138 format++;
2139 }
2140 assert(!IS_END_OF_FORMAT(*format));
2141
Serhiy Storchaka17414412017-01-17 10:07:25 +02002142 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002143 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002144 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002145 else if (nkwargs && i >= pos) {
2146 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002147 if (kwargs != NULL) {
2148 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2149 if (!current_arg && PyErr_Occurred()) {
2150 return cleanreturn(0, &freelist);
2151 }
2152 }
2153 else {
2154 current_arg = find_keyword(kwnames, kwstack, keyword);
2155 }
2156 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002157 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002158 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002159 }
2160 else {
2161 current_arg = NULL;
2162 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002163
2164 if (current_arg) {
2165 msg = convertitem(current_arg, &format, p_va, flags,
2166 levels, msgbuf, sizeof(msgbuf), &freelist);
2167 if (msg) {
2168 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2169 return cleanreturn(0, &freelist);
2170 }
2171 continue;
2172 }
2173
2174 if (i < parser->min) {
2175 /* Less arguments than required */
2176 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002177 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002178 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302179 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002180 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002181 (parser->fname == NULL) ? "function" : parser->fname,
2182 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002183 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302184 min,
2185 min == 1 ? "" : "s",
2186 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002187 }
2188 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002189 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002190 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2191 "argument '%U' (pos %d)",
2192 (parser->fname == NULL) ? "function" : parser->fname,
2193 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002194 keyword, i+1);
2195 }
2196 return cleanreturn(0, &freelist);
2197 }
2198 /* current code reports success when all required args
2199 * fulfilled and no keyword args left, with no further
2200 * validation. XXX Maybe skip this in debug build ?
2201 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002202 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002203 return cleanreturn(1, &freelist);
2204 }
2205
Leo Ariasc3d95082018-02-03 18:36:10 -06002206 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002207 * keyword args */
2208 msg = skipitem(&format, p_va, flags);
2209 assert(msg == NULL);
2210 }
2211
2212 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2213
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002214 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002215 Py_ssize_t j;
2216 /* make sure there are no arguments given by name and position */
2217 for (i = pos; i < nargs; i++) {
2218 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002219 if (kwargs != NULL) {
2220 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2221 if (!current_arg && PyErr_Occurred()) {
2222 return cleanreturn(0, &freelist);
2223 }
2224 }
2225 else {
2226 current_arg = find_keyword(kwnames, kwstack, keyword);
2227 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002228 if (current_arg) {
2229 /* arg present in tuple and in dict */
2230 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002231 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002232 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002233 (parser->fname == NULL) ? "function" : parser->fname,
2234 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002235 keyword, i+1);
2236 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002237 }
2238 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002239 /* make sure there are no extraneous keyword arguments */
2240 j = 0;
2241 while (1) {
2242 int match;
2243 if (kwargs != NULL) {
2244 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2245 break;
2246 }
2247 else {
2248 if (j >= PyTuple_GET_SIZE(kwnames))
2249 break;
2250 keyword = PyTuple_GET_ITEM(kwnames, j);
2251 j++;
2252 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002253
Serhiy Storchaka17414412017-01-17 10:07:25 +02002254 match = PySequence_Contains(kwtuple, keyword);
2255 if (match <= 0) {
2256 if (!match) {
2257 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002258 "'%S' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002259 "argument for %.200s%s",
2260 keyword,
2261 (parser->fname == NULL) ? "this function" : parser->fname,
2262 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002263 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002264 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002265 }
2266 }
2267 }
2268
2269 return cleanreturn(1, &freelist);
2270}
2271
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002272static int
2273vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2274 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2275{
2276 PyObject **stack;
2277 Py_ssize_t nargs;
2278
Victor Stinner80ab22f2017-01-16 23:16:47 +01002279 if (args == NULL
2280 || !PyTuple_Check(args)
2281 || (keywords != NULL && !PyDict_Check(keywords)))
2282 {
2283 PyErr_BadInternalCall();
2284 return 0;
2285 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002286
Victor Stinnerd17a6932018-11-09 16:56:48 +01002287 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002288 nargs = PyTuple_GET_SIZE(args);
2289 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2290 parser, p_va, flags);
2291}
2292
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002293
Serhiy Storchaka31913912019-03-14 10:32:22 +02002294#undef _PyArg_UnpackKeywords
2295
2296PyObject * const *
2297_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2298 PyObject *kwargs, PyObject *kwnames,
2299 struct _PyArg_Parser *parser,
2300 int minpos, int maxpos, int minkw,
2301 PyObject **buf)
2302{
2303 PyObject *kwtuple;
2304 PyObject *keyword;
2305 int i, posonly, minposonly, maxargs;
2306 int reqlimit = minkw ? maxpos + minkw : minpos;
2307 Py_ssize_t nkwargs;
2308 PyObject *current_arg;
2309 PyObject * const *kwstack = NULL;
2310
2311 assert(kwargs == NULL || PyDict_Check(kwargs));
2312 assert(kwargs == NULL || kwnames == NULL);
2313
2314 if (parser == NULL) {
2315 PyErr_BadInternalCall();
2316 return NULL;
2317 }
2318
2319 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2320 PyErr_BadInternalCall();
2321 return NULL;
2322 }
2323
2324 if (args == NULL && nargs == 0) {
2325 args = buf;
2326 }
2327
2328 if (!parser_init(parser)) {
2329 return NULL;
2330 }
2331
2332 kwtuple = parser->kwtuple;
2333 posonly = parser->pos;
2334 minposonly = Py_MIN(posonly, minpos);
2335 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2336
2337 if (kwargs != NULL) {
2338 nkwargs = PyDict_GET_SIZE(kwargs);
2339 }
2340 else if (kwnames != NULL) {
2341 nkwargs = PyTuple_GET_SIZE(kwnames);
2342 kwstack = args + nargs;
2343 }
2344 else {
2345 nkwargs = 0;
2346 }
2347 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2348 /* Fast path. */
2349 return args;
2350 }
2351 if (nargs + nkwargs > maxargs) {
2352 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2353 messages in some special cases (see bpo-31229). */
2354 PyErr_Format(PyExc_TypeError,
2355 "%.200s%s takes at most %d %sargument%s (%zd given)",
2356 (parser->fname == NULL) ? "function" : parser->fname,
2357 (parser->fname == NULL) ? "" : "()",
2358 maxargs,
2359 (nargs == 0) ? "keyword " : "",
2360 (maxargs == 1) ? "" : "s",
2361 nargs + nkwargs);
2362 return NULL;
2363 }
2364 if (nargs > maxpos) {
2365 if (maxpos == 0) {
2366 PyErr_Format(PyExc_TypeError,
2367 "%.200s%s takes no positional arguments",
2368 (parser->fname == NULL) ? "function" : parser->fname,
2369 (parser->fname == NULL) ? "" : "()");
2370 }
2371 else {
2372 PyErr_Format(PyExc_TypeError,
2373 "%.200s%s takes %s %d positional argument%s (%zd given)",
2374 (parser->fname == NULL) ? "function" : parser->fname,
2375 (parser->fname == NULL) ? "" : "()",
2376 (minpos < maxpos) ? "at most" : "exactly",
2377 maxpos,
2378 (maxpos == 1) ? "" : "s",
2379 nargs);
2380 }
2381 return NULL;
2382 }
2383 if (nargs < minposonly) {
2384 PyErr_Format(PyExc_TypeError,
2385 "%.200s%s takes %s %d positional argument%s"
2386 " (%zd given)",
2387 (parser->fname == NULL) ? "function" : parser->fname,
2388 (parser->fname == NULL) ? "" : "()",
2389 minposonly < maxpos ? "at least" : "exactly",
2390 minposonly,
2391 minposonly == 1 ? "" : "s",
2392 nargs);
2393 return NULL;
2394 }
2395
2396 /* copy tuple args */
2397 for (i = 0; i < nargs; i++) {
2398 buf[i] = args[i];
2399 }
2400
2401 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002402 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002403 if (nkwargs) {
2404 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2405 if (kwargs != NULL) {
2406 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2407 if (!current_arg && PyErr_Occurred()) {
2408 return NULL;
2409 }
2410 }
2411 else {
2412 current_arg = find_keyword(kwnames, kwstack, keyword);
2413 }
2414 }
2415 else if (i >= reqlimit) {
2416 break;
2417 }
2418 else {
2419 current_arg = NULL;
2420 }
2421
2422 buf[i] = current_arg;
2423
2424 if (current_arg) {
2425 --nkwargs;
2426 }
2427 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2428 /* Less arguments than required */
2429 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2430 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2431 "argument '%U' (pos %d)",
2432 (parser->fname == NULL) ? "function" : parser->fname,
2433 (parser->fname == NULL) ? "" : "()",
2434 keyword, i+1);
2435 return NULL;
2436 }
2437 }
2438
2439 if (nkwargs > 0) {
2440 Py_ssize_t j;
2441 /* make sure there are no arguments given by name and position */
2442 for (i = posonly; i < nargs; i++) {
2443 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2444 if (kwargs != NULL) {
2445 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2446 if (!current_arg && PyErr_Occurred()) {
2447 return NULL;
2448 }
2449 }
2450 else {
2451 current_arg = find_keyword(kwnames, kwstack, keyword);
2452 }
2453 if (current_arg) {
2454 /* arg present in tuple and in dict */
2455 PyErr_Format(PyExc_TypeError,
2456 "argument for %.200s%s given by name ('%U') "
2457 "and position (%d)",
2458 (parser->fname == NULL) ? "function" : parser->fname,
2459 (parser->fname == NULL) ? "" : "()",
2460 keyword, i+1);
2461 return NULL;
2462 }
2463 }
2464 /* make sure there are no extraneous keyword arguments */
2465 j = 0;
2466 while (1) {
2467 int match;
2468 if (kwargs != NULL) {
2469 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2470 break;
2471 }
2472 else {
2473 if (j >= PyTuple_GET_SIZE(kwnames))
2474 break;
2475 keyword = PyTuple_GET_ITEM(kwnames, j);
2476 j++;
2477 }
2478
Serhiy Storchaka31913912019-03-14 10:32:22 +02002479 match = PySequence_Contains(kwtuple, keyword);
2480 if (match <= 0) {
2481 if (!match) {
2482 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002483 "'%S' is an invalid keyword "
Serhiy Storchaka31913912019-03-14 10:32:22 +02002484 "argument for %.200s%s",
2485 keyword,
2486 (parser->fname == NULL) ? "this function" : parser->fname,
2487 (parser->fname == NULL) ? "" : "()");
2488 }
2489 return NULL;
2490 }
2491 }
2492 }
2493
2494 return buf;
2495}
2496
2497
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002498static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002499skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002500{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 const char *format = *p_format;
2502 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002503
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002505
Larry Hastingsa3479012012-05-08 23:52:03 -07002506 /*
2507 * codes that take a single data pointer as an argument
2508 * (the type of the pointer is irrelevant)
2509 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002511 case 'b': /* byte -- very short int */
2512 case 'B': /* byte as bitfield */
2513 case 'h': /* short int */
2514 case 'H': /* short int as bitfield */
2515 case 'i': /* int */
2516 case 'I': /* int sized bitfield */
2517 case 'l': /* long int */
2518 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002519 case 'L': /* long long */
2520 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002521 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002522 case 'f': /* float */
2523 case 'd': /* double */
2524 case 'D': /* complex double */
2525 case 'c': /* char */
2526 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002527 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002528 case 'S': /* string object */
2529 case 'Y': /* string object */
2530 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002532 if (p_va != NULL) {
2533 (void) va_arg(*p_va, void *);
2534 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 break;
2536 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002539
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002540 case 'e': /* string with encoding */
2541 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002542 if (p_va != NULL) {
2543 (void) va_arg(*p_va, const char *);
2544 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 if (!(*format == 's' || *format == 't'))
2546 /* after 'e', only 's' and 't' is allowed */
2547 goto err;
2548 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 }
Stefan Krahf432a322017-08-21 13:09:59 +02002550 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002551
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 case 's': /* string */
2553 case 'z': /* string or None */
2554 case 'y': /* bytes */
2555 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002556 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 case 'w': /* buffer, read-write */
2558 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002559 if (p_va != NULL) {
2560 (void) va_arg(*p_va, char **);
2561 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002563 if (p_va != NULL) {
2564 if (flags & FLAG_SIZE_T)
2565 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002566 else {
2567 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2568 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2569 return NULL;
2570 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002571 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002572 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002573 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002575 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2576 && *format == '*')
2577 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002578 format++;
2579 }
2580 break;
2581 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002582
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 case 'O': /* object */
2584 {
2585 if (*format == '!') {
2586 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002587 if (p_va != NULL) {
2588 (void) va_arg(*p_va, PyTypeObject*);
2589 (void) va_arg(*p_va, PyObject **);
2590 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 }
2592 else if (*format == '&') {
2593 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002594 if (p_va != NULL) {
2595 (void) va_arg(*p_va, converter);
2596 (void) va_arg(*p_va, void *);
2597 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 format++;
2599 }
2600 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002601 if (p_va != NULL) {
2602 (void) va_arg(*p_va, PyObject **);
2603 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 }
2605 break;
2606 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002607
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002608 case '(': /* bypass tuple, not handled at all previously */
2609 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002610 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 for (;;) {
2612 if (*format==')')
2613 break;
2614 if (IS_END_OF_FORMAT(*format))
2615 return "Unmatched left paren in format "
2616 "string";
2617 msg = skipitem(&format, p_va, flags);
2618 if (msg)
2619 return msg;
2620 }
2621 format++;
2622 break;
2623 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 case ')':
2626 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002629err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002630 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002631
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002633
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002634 *p_format = format;
2635 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002636}
Fred Drakee4616e62001-10-23 21:09:29 +00002637
2638
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002639#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002640
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002641int
2642_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2643 Py_ssize_t min, Py_ssize_t max)
2644{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 assert(min >= 0);
2646 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002647
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002648 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002649 if (name != NULL)
2650 PyErr_Format(
2651 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302652 "%.200s expected %s%zd argument%s, got %zd",
2653 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 else
2655 PyErr_Format(
2656 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302657 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302659 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 return 0;
2661 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002662
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002663 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002664 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002665 }
2666
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002667 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 if (name != NULL)
2669 PyErr_Format(
2670 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302671 "%.200s expected %s%zd argument%s, got %zd",
2672 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002673 else
2674 PyErr_Format(
2675 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302676 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302678 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 return 0;
2680 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002681
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002682 return 1;
2683}
2684
2685static int
2686unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2687 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2688{
2689 Py_ssize_t i;
2690 PyObject **o;
2691
2692 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2693 return 0;
2694 }
2695
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002696 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002697 o = va_arg(vargs, PyObject **);
2698 *o = args[i];
2699 }
2700 return 1;
2701}
2702
2703int
2704PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2705{
2706 PyObject **stack;
2707 Py_ssize_t nargs;
2708 int retval;
2709 va_list vargs;
2710
2711 if (!PyTuple_Check(args)) {
2712 PyErr_SetString(PyExc_SystemError,
2713 "PyArg_UnpackTuple() argument list is not a tuple");
2714 return 0;
2715 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002716 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002717 nargs = PyTuple_GET_SIZE(args);
2718
Raymond Hettinger94230232016-03-26 03:02:48 -07002719#ifdef HAVE_STDARG_PROTOTYPES
2720 va_start(vargs, max);
2721#else
2722 va_start(vargs);
2723#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002724 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002726 return retval;
2727}
2728
2729int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002730_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002731 Py_ssize_t min, Py_ssize_t max, ...)
2732{
2733 int retval;
2734 va_list vargs;
2735
2736#ifdef HAVE_STDARG_PROTOTYPES
2737 va_start(vargs, max);
2738#else
2739 va_start(vargs);
2740#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002741 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002742 va_end(vargs);
2743 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002744}
Georg Brandl02c42872005-08-26 06:42:30 +00002745
2746
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002747#undef _PyArg_NoKeywords
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002748#undef _PyArg_NoKwnames
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002749#undef _PyArg_NoPositional
2750
Georg Brandl02c42872005-08-26 06:42:30 +00002751/* For type constructors that don't take keyword args
2752 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002753 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002754 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002755 */
2756int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002757_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002758{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002759 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002760 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002761 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002762 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 PyErr_BadInternalCall();
2764 return 0;
2765 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002766 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002767 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002768 }
2769
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002770 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002771 funcname);
2772 return 0;
2773}
2774
Victor Stinner29d39cc2017-01-17 01:40:01 +01002775int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002776_PyArg_NoPositional(const char *funcname, PyObject *args)
2777{
2778 if (args == NULL)
2779 return 1;
2780 if (!PyTuple_CheckExact(args)) {
2781 PyErr_BadInternalCall();
2782 return 0;
2783 }
2784 if (PyTuple_GET_SIZE(args) == 0)
2785 return 1;
2786
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002787 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002788 funcname);
2789 return 0;
2790}
2791
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002792int
2793_PyArg_NoKwnames(const char *funcname, PyObject *kwnames)
2794{
2795 if (kwnames == NULL) {
2796 return 1;
2797 }
2798
2799 assert(PyTuple_CheckExact(kwnames));
2800
2801 if (PyTuple_GET_SIZE(kwnames) == 0) {
2802 return 1;
2803 }
2804
2805 PyErr_Format(PyExc_TypeError, "%s() takes no keyword arguments", funcname);
2806 return 0;
2807}
2808
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002809void
2810_PyArg_Fini(void)
2811{
2812 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2813 while (s) {
2814 tmp = s->next;
2815 s->next = NULL;
2816 parser_clear(s);
2817 s = tmp;
2818 }
2819 static_arg_parsers = NULL;
2820}
2821
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002822#ifdef __cplusplus
2823};
2824#endif