blob: 59f0fdabb74a656f0e0ea1e98ea94a82c6c85691 [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
109int
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
Martin v. Löwis18e16552006-02-15 17:27:45 +0000134int
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
159int
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
Martin v. Löwis18e16552006-02-15 17:27:45 +0000185int
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) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100315 if (Py_ISALPHA(Py_CHARMASK(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
Antoine Pitrou4de74572013-02-09 23:11:27 +0100400 if (*format != '\0' && !Py_ISALPHA(Py_CHARMASK(*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;
Antoine Pitrou4de74572013-02-09 23:11:27 +0100524 else if (level == 0 && Py_ISALPHA(Py_CHARMASK(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,
534 arg == Py_None ? "None" : arg->ob_type->tp_name);
535 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
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000613/* Format an error message generated by convertsimple(). */
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000614
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200615void
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200616_PyArg_BadArgument(const char *fname, int iarg,
617 const char *expected, PyObject *arg)
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200618{
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200619 if (iarg) {
620 PyErr_Format(PyExc_TypeError,
621 "%.200s() argument %d must be %.50s, not %.50s",
622 fname, iarg, expected,
623 arg == Py_None ? "None" : arg->ob_type->tp_name);
624 }
625 else {
626 PyErr_Format(PyExc_TypeError,
627 "%.200s() argument must be %.50s, not %.50s",
628 fname, expected,
629 arg == Py_None ? "None" : arg->ob_type->tp_name);
630 }
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200631}
632
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200633static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000634converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000635{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000636 assert(expected != NULL);
637 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200638 if (expected[0] == '(') {
639 PyOS_snprintf(msgbuf, bufsize,
640 "%.100s", expected);
641 }
642 else {
643 PyOS_snprintf(msgbuf, bufsize,
644 "must be %.50s, not %.50s", expected,
645 arg == Py_None ? "None" : arg->ob_type->tp_name);
646 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000647 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000648}
649
650#define CONV_UNICODE "(unicode conversion error)"
651
Guido van Rossum45aecf42006-03-15 04:58:47 +0000652/* Explicitly check for float arguments when integers are expected.
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200653 Return 1 for error, 0 if ok.
654 XXX Should be removed after the end of the deprecation period in
655 _PyLong_FromNbIndexOrNbInt. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000656static int
657float_argument_error(PyObject *arg)
658{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000659 if (PyFloat_Check(arg)) {
660 PyErr_SetString(PyExc_TypeError,
661 "integer argument expected, got float" );
662 return 1;
663 }
664 else
665 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000666}
667
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000668/* Convert a non-tuple argument. Return NULL if conversion went OK,
669 or a string with a message describing the failure. The message is
670 formatted as "must be <desired type>, not <actual type>".
671 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000672 Don't call if a tuple is expected.
673
674 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000675*/
676
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200677static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000678convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400679 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000680{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000681 /* For # codes */
682#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
683 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
Inada Naokid3c72a22019-03-23 21:04:40 +0900684 else { \
685 if (PyErr_WarnEx(PyExc_DeprecationWarning, \
686 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) { \
687 return NULL; \
688 } \
689 q=va_arg(*p_va, int*); \
690 }
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000691#define STORE_SIZE(s) \
692 if (flags & FLAG_SIZE_T) \
693 *q2=s; \
694 else { \
695 if (INT_MAX < s) { \
696 PyErr_SetString(PyExc_OverflowError, \
697 "size does not fit in an int"); \
698 return converterr("", arg, msgbuf, bufsize); \
699 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200700 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000701 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000702#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000703#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 const char *format = *p_format;
706 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200707 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000711 case 'b': { /* unsigned byte -- very short int */
712 char *p = va_arg(*p_va, char *);
713 long ival;
714 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000715 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000716 ival = PyLong_AsLong(arg);
717 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000718 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000719 else if (ival < 0) {
720 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000721 "unsigned byte integer is less than minimum");
722 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000723 }
724 else if (ival > UCHAR_MAX) {
725 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000726 "unsigned byte integer is greater than maximum");
727 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 }
729 else
730 *p = (unsigned char) ival;
731 break;
732 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000733
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 case 'B': {/* byte sized bitfield - both signed and unsigned
735 values allowed */
736 char *p = va_arg(*p_va, char *);
737 long ival;
738 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000739 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 ival = PyLong_AsUnsignedLongMask(arg);
741 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000742 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000743 else
744 *p = (unsigned char) ival;
745 break;
746 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000748 case 'h': {/* signed short int */
749 short *p = va_arg(*p_va, short *);
750 long ival;
751 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000752 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 ival = PyLong_AsLong(arg);
754 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 < SHRT_MIN) {
757 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000758 "signed short integer is less than minimum");
759 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000760 }
761 else if (ival > SHRT_MAX) {
762 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000763 "signed short integer is greater than maximum");
764 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 }
766 else
767 *p = (short) ival;
768 break;
769 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000770
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 case 'H': { /* short int sized bitfield, both signed and
772 unsigned allowed */
773 unsigned short *p = va_arg(*p_va, unsigned short *);
774 long ival;
775 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000776 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000777 ival = PyLong_AsUnsignedLongMask(arg);
778 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000779 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000780 else
781 *p = (unsigned short) ival;
782 break;
783 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000785 case 'i': {/* signed int */
786 int *p = va_arg(*p_va, int *);
787 long ival;
788 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000789 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000790 ival = PyLong_AsLong(arg);
791 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000792 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 else if (ival > INT_MAX) {
794 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000795 "signed integer is greater than maximum");
796 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000797 }
798 else if (ival < INT_MIN) {
799 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000800 "signed integer is less than minimum");
801 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 }
803 else
804 *p = ival;
805 break;
806 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000807
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 case 'I': { /* int sized bitfield, both signed and
809 unsigned allowed */
810 unsigned int *p = va_arg(*p_va, unsigned int *);
811 unsigned int ival;
812 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000813 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000814 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
815 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000816 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000817 else
818 *p = ival;
819 break;
820 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000821
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000822 case 'n': /* Py_ssize_t */
823 {
824 PyObject *iobj;
825 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
826 Py_ssize_t ival = -1;
827 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000828 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000829 iobj = PyNumber_Index(arg);
830 if (iobj != NULL) {
831 ival = PyLong_AsSsize_t(iobj);
832 Py_DECREF(iobj);
833 }
834 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000835 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000836 *p = ival;
837 break;
838 }
839 case 'l': {/* long int */
840 long *p = va_arg(*p_va, long *);
841 long ival;
842 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000843 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000844 ival = PyLong_AsLong(arg);
845 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000846 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000847 else
848 *p = ival;
849 break;
850 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000851
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000852 case 'k': { /* long sized bitfield */
853 unsigned long *p = va_arg(*p_va, unsigned long *);
854 unsigned long ival;
855 if (PyLong_Check(arg))
856 ival = PyLong_AsUnsignedLongMask(arg);
857 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200858 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000859 *p = ival;
860 break;
861 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000862
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700863 case 'L': {/* long long */
864 long long *p = va_arg( *p_va, long long * );
865 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000866 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000867 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000868 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700869 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000870 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000871 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000872 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 break;
874 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000875
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000876 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700877 unsigned long long *p = va_arg(*p_va, unsigned long long *);
878 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000879 if (PyLong_Check(arg))
880 ival = PyLong_AsUnsignedLongLongMask(arg);
881 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200882 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000883 *p = ival;
884 break;
885 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000886
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000887 case 'f': {/* float */
888 float *p = va_arg(*p_va, float *);
889 double dval = PyFloat_AsDouble(arg);
890 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000891 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000892 else
893 *p = (float) dval;
894 break;
895 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000896
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 case 'd': {/* double */
898 double *p = va_arg(*p_va, double *);
899 double dval = PyFloat_AsDouble(arg);
900 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000901 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000902 else
903 *p = dval;
904 break;
905 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000906
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 case 'D': {/* complex double */
908 Py_complex *p = va_arg(*p_va, Py_complex *);
909 Py_complex cval;
910 cval = PyComplex_AsCComplex(arg);
911 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000912 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 else
914 *p = cval;
915 break;
916 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000917
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 case 'c': {/* char */
919 char *p = va_arg(*p_va, char *);
920 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
921 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300922 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
923 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 else
925 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
926 break;
927 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000928
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 case 'C': {/* unicode char */
930 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200931 int kind;
932 void *data;
933
934 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200936
937 if (PyUnicode_READY(arg))
938 RETURN_ERR_OCCURRED;
939
940 if (PyUnicode_GET_LENGTH(arg) != 1)
941 return converterr("a unicode character", arg, msgbuf, bufsize);
942
943 kind = PyUnicode_KIND(arg);
944 data = PyUnicode_DATA(arg);
945 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000946 break;
947 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000948
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700949 case 'p': {/* boolean *p*redicate */
950 int *p = va_arg(*p_va, int *);
951 int val = PyObject_IsTrue(arg);
952 if (val > 0)
953 *p = 1;
954 else if (val == 0)
955 *p = 0;
956 else
957 RETURN_ERR_OCCURRED;
958 break;
959 }
960
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000961 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000963
Serhiy Storchakab757c832014-12-05 22:25:22 +0200964 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200966 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 Py_ssize_t count;
968 if (*format == '*') {
969 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
970 return converterr(buf, arg, msgbuf, bufsize);
971 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400972 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000973 return converterr(
974 "(cleanup problem)",
975 arg, msgbuf, bufsize);
976 }
977 break;
978 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200979 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 if (count < 0)
981 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000982 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000983 FETCH_SIZE;
984 STORE_SIZE(count);
985 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000986 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300987 if (strlen(*p) != (size_t)count) {
988 PyErr_SetString(PyExc_ValueError, "embedded null byte");
989 RETURN_ERR_OCCURRED;
990 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 }
992 break;
993 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000994
Serhiy Storchakab757c832014-12-05 22:25:22 +0200995 case 's': /* text string or bytes-like object */
996 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000997 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000998 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000999 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001000 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +00001001
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001002 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001003 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
1004 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001005 Py_ssize_t len;
1006 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1007 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 return converterr(CONV_UNICODE,
1009 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001010 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001011 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001012 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001013 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001014 if (getbuffer(arg, p, &buf) < 0)
1015 return converterr(buf, arg, msgbuf, bufsize);
1016 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001017 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001018 return converterr(
1019 "(cleanup problem)",
1020 arg, msgbuf, bufsize);
1021 }
1022 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +02001023 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001024 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001025 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001026 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001027
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001028 if (c == 'z' && arg == Py_None) {
1029 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 STORE_SIZE(0);
1031 }
1032 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001033 Py_ssize_t len;
1034 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1035 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 return converterr(CONV_UNICODE,
1037 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001038 *p = sarg;
1039 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001040 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001041 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001042 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001043 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001044 Py_ssize_t count = convertbuffer(arg, p, &buf);
1045 if (count < 0)
1046 return converterr(buf, arg, msgbuf, bufsize);
1047 STORE_SIZE(count);
1048 }
1049 format++;
1050 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001051 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001052 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001053 Py_ssize_t len;
1054 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001055
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001056 if (c == 'z' && arg == Py_None)
1057 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001059 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1060 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 return converterr(CONV_UNICODE,
1062 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001063 if (strlen(sarg) != (size_t)len) {
1064 PyErr_SetString(PyExc_ValueError, "embedded null character");
1065 RETURN_ERR_OCCURRED;
1066 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001067 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001068 }
1069 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001070 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001072 }
1073 break;
1074 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001075
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001076 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1077 case 'Z': /* raw unicode buffer or None */
1078 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001079 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1080
Serhiy Storchakab757c832014-12-05 22:25:22 +02001081 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001082 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001083 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001084
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001085 if (c == 'Z' && arg == Py_None) {
1086 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001087 STORE_SIZE(0);
1088 }
1089 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001090 Py_ssize_t len;
1091 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001092 if (*p == NULL)
1093 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001094 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001095 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001096 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001097 return converterr(c == 'Z' ? "str or None" : "str",
1098 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001099 format++;
1100 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001101 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001102 if (c == 'Z' && arg == Py_None)
1103 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001104 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001105 Py_ssize_t len;
1106 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001107 if (*p == NULL)
1108 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001109 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001110 PyErr_SetString(PyExc_ValueError, "embedded null character");
1111 RETURN_ERR_OCCURRED;
1112 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001113 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001114 return converterr(c == 'Z' ? "str or None" : "str",
1115 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 }
1117 break;
1118 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001119
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001120 case 'e': {/* encoded string */
1121 char **buffer;
1122 const char *encoding;
1123 PyObject *s;
1124 int recode_strings;
1125 Py_ssize_t size;
1126 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 /* Get 'e' parameter: the encoding name */
1129 encoding = (const char *)va_arg(*p_va, const char *);
1130 if (encoding == NULL)
1131 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001132
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001133 /* Get output buffer parameter:
1134 's' (recode all objects via Unicode) or
1135 't' (only recode non-string objects)
1136 */
1137 if (*format == 's')
1138 recode_strings = 1;
1139 else if (*format == 't')
1140 recode_strings = 0;
1141 else
1142 return converterr(
1143 "(unknown parser marker combination)",
1144 arg, msgbuf, bufsize);
1145 buffer = (char **)va_arg(*p_va, char **);
1146 format++;
1147 if (buffer == NULL)
1148 return converterr("(buffer is NULL)",
1149 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001150
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001151 /* Encode object */
1152 if (!recode_strings &&
1153 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1154 s = arg;
1155 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001156 if (PyBytes_Check(arg)) {
1157 size = PyBytes_GET_SIZE(s);
1158 ptr = PyBytes_AS_STRING(s);
1159 }
1160 else {
1161 size = PyByteArray_GET_SIZE(s);
1162 ptr = PyByteArray_AS_STRING(s);
1163 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001165 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001167 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 encoding,
1169 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 if (s == NULL)
1171 return converterr("(encoding failed)",
1172 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001173 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001174 size = PyBytes_GET_SIZE(s);
1175 ptr = PyBytes_AS_STRING(s);
1176 if (ptr == NULL)
1177 ptr = "";
1178 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001179 else {
1180 return converterr(
1181 recode_strings ? "str" : "str, bytes or bytearray",
1182 arg, msgbuf, bufsize);
1183 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001184
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001185 /* Write output; output is guaranteed to be 0-terminated */
1186 if (*format == '#') {
1187 /* Using buffer length parameter '#':
1188
1189 - if *buffer is NULL, a new buffer of the
1190 needed size is allocated and the data
1191 copied into it; *buffer is updated to point
1192 to the new buffer; the caller is
1193 responsible for PyMem_Free()ing it after
1194 usage
1195
1196 - if *buffer is not NULL, the data is
1197 copied to *buffer; *buffer_len has to be
1198 set to the size of the buffer on input;
1199 buffer overflow is signalled with an error;
1200 buffer has to provide enough room for the
1201 encoded string plus the trailing 0-byte
1202
1203 - in both cases, *buffer_len is updated to
1204 the size of the buffer /excluding/ the
1205 trailing 0-byte
1206
1207 */
1208 FETCH_SIZE;
1209
1210 format++;
1211 if (q == NULL && q2 == NULL) {
1212 Py_DECREF(s);
1213 return converterr(
1214 "(buffer_len is NULL)",
1215 arg, msgbuf, bufsize);
1216 }
1217 if (*buffer == NULL) {
1218 *buffer = PyMem_NEW(char, size + 1);
1219 if (*buffer == NULL) {
1220 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001221 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001222 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001223 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001224 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 Py_DECREF(s);
1226 return converterr(
1227 "(cleanup problem)",
1228 arg, msgbuf, bufsize);
1229 }
1230 } else {
1231 if (size + 1 > BUFFER_LEN) {
1232 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001233 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001234 "encoded string too long "
1235 "(%zd, maximum length %zd)",
1236 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1237 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 }
1239 }
1240 memcpy(*buffer, ptr, size+1);
1241 STORE_SIZE(size);
1242 } else {
1243 /* Using a 0-terminated buffer:
1244
1245 - the encoded string has to be 0-terminated
1246 for this variant to work; if it is not, an
1247 error raised
1248
1249 - a new buffer of the needed size is
1250 allocated and the data copied into it;
1251 *buffer is updated to point to the new
1252 buffer; the caller is responsible for
1253 PyMem_Free()ing it after usage
1254
1255 */
1256 if ((Py_ssize_t)strlen(ptr) != size) {
1257 Py_DECREF(s);
1258 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001259 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 arg, msgbuf, bufsize);
1261 }
1262 *buffer = PyMem_NEW(char, size + 1);
1263 if (*buffer == NULL) {
1264 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001265 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001266 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001267 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001268 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 Py_DECREF(s);
1270 return converterr("(cleanup problem)",
1271 arg, msgbuf, bufsize);
1272 }
1273 memcpy(*buffer, ptr, size+1);
1274 }
1275 Py_DECREF(s);
1276 break;
1277 }
1278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 case 'S': { /* PyBytes object */
1280 PyObject **p = va_arg(*p_va, PyObject **);
1281 if (PyBytes_Check(arg))
1282 *p = arg;
1283 else
1284 return converterr("bytes", arg, msgbuf, bufsize);
1285 break;
1286 }
1287
1288 case 'Y': { /* PyByteArray object */
1289 PyObject **p = va_arg(*p_va, PyObject **);
1290 if (PyByteArray_Check(arg))
1291 *p = arg;
1292 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001293 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001294 break;
1295 }
1296
1297 case 'U': { /* PyUnicode object */
1298 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001299 if (PyUnicode_Check(arg)) {
1300 if (PyUnicode_READY(arg) == -1)
1301 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001302 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001303 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001304 else
1305 return converterr("str", arg, msgbuf, bufsize);
1306 break;
1307 }
1308
1309 case 'O': { /* object */
1310 PyTypeObject *type;
1311 PyObject **p;
1312 if (*format == '!') {
1313 type = va_arg(*p_va, PyTypeObject*);
1314 p = va_arg(*p_va, PyObject **);
1315 format++;
1316 if (PyType_IsSubtype(arg->ob_type, type))
1317 *p = arg;
1318 else
1319 return converterr(type->tp_name, arg, msgbuf, bufsize);
1320
1321 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 else if (*format == '&') {
1323 typedef int (*converter)(PyObject *, void *);
1324 converter convert = va_arg(*p_va, converter);
1325 void *addr = va_arg(*p_va, void *);
1326 int res;
1327 format++;
1328 if (! (res = (*convert)(arg, addr)))
1329 return converterr("(unspecified)",
1330 arg, msgbuf, bufsize);
1331 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001332 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001333 return converterr("(cleanup problem)",
1334 arg, msgbuf, bufsize);
1335 }
1336 else {
1337 p = va_arg(*p_va, PyObject **);
1338 *p = arg;
1339 }
1340 break;
1341 }
1342
1343
Victor Stinner25e8ec42010-06-25 00:02:38 +00001344 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346
Victor Stinner25e8ec42010-06-25 00:02:38 +00001347 if (*format != '*')
1348 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001349 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001350 arg, msgbuf, bufsize);
1351 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001352
Victor Stinner25e8ec42010-06-25 00:02:38 +00001353 /* Caller is interested in Py_buffer, and the object
1354 supports it directly. */
1355 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1356 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001357 return converterr("read-write bytes-like object",
1358 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 }
Victor Stinner8182b712010-07-28 00:40:58 +00001360 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1361 PyBuffer_Release((Py_buffer*)p);
1362 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1363 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001364 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001365 return converterr(
1366 "(cleanup problem)",
1367 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 break;
1370 }
1371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001373 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374
1375 }
1376
1377 *p_format = format;
1378 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001379
1380#undef FETCH_SIZE
1381#undef STORE_SIZE
1382#undef BUFFER_LEN
1383#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001384}
Guido van Rossumaa354651996-08-19 19:32:04 +00001385
Martin v. Löwis18e16552006-02-15 17:27:45 +00001386static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001387convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001388{
Victor Stinner5cb62392010-06-06 20:27:51 +00001389 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 Py_ssize_t count;
1391 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001392
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001393 *errmsg = NULL;
1394 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001395 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001396 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 return -1;
1398 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001399
Victor Stinner8182b712010-07-28 00:40:58 +00001400 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001402 count = view.len;
1403 *p = view.buf;
1404 PyBuffer_Release(&view);
1405 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001406}
Guido van Rossumaa354651996-08-19 19:32:04 +00001407
Martin v. Löwis423be952008-08-13 15:53:07 +00001408static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001409getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001410{
Victor Stinner8182b712010-07-28 00:40:58 +00001411 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001412 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001413 return -1;
1414 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001415 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001416 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001417 *errmsg = "contiguous buffer";
1418 return -1;
1419 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001421}
1422
Guido van Rossumaa354651996-08-19 19:32:04 +00001423/* Support for keyword arguments donated by
1424 Geoff Philbrick <philbric@delphi.hks.com> */
1425
Tim Petersf8cd3e82001-10-27 04:26:57 +00001426/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001427int
1428PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 PyObject *keywords,
1430 const char *format,
1431 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 int retval;
1434 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +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 }
Tim Peters45772cd2001-10-27 03:58:40 +00001444
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001445 va_start(va, kwlist);
1446 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1447 va_end(va);
1448 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001449}
1450
1451int
1452_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 PyObject *keywords,
1454 const char *format,
1455 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001456{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 int retval;
1458 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001459
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001460 if ((args == NULL || !PyTuple_Check(args)) ||
1461 (keywords != NULL && !PyDict_Check(keywords)) ||
1462 format == NULL ||
1463 kwlist == NULL)
1464 {
1465 PyErr_BadInternalCall();
1466 return 0;
1467 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001468
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 va_start(va, kwlist);
1470 retval = vgetargskeywords(args, keywords, format,
1471 kwlist, &va, FLAG_SIZE_T);
1472 va_end(va);
1473 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001474}
1475
1476
Brett Cannon711e7d92004-07-10 22:20:32 +00001477int
1478PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001479 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001480 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001481 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 int retval;
1484 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 if ((args == NULL || !PyTuple_Check(args)) ||
1487 (keywords != NULL && !PyDict_Check(keywords)) ||
1488 format == NULL ||
1489 kwlist == NULL)
1490 {
1491 PyErr_BadInternalCall();
1492 return 0;
1493 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001494
Benjamin Peterson0c212142016-09-20 20:39:33 -07001495 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001498 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001499 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001500}
1501
1502int
1503_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 PyObject *keywords,
1505 const char *format,
1506 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001507{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 int retval;
1509 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001510
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 if ((args == NULL || !PyTuple_Check(args)) ||
1512 (keywords != NULL && !PyDict_Check(keywords)) ||
1513 format == NULL ||
1514 kwlist == NULL)
1515 {
1516 PyErr_BadInternalCall();
1517 return 0;
1518 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001519
Benjamin Peterson0c212142016-09-20 20:39:33 -07001520 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001521
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001522 retval = vgetargskeywords(args, keywords, format,
1523 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001524 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001526}
1527
Benjamin Petersonfb886362010-04-24 18:21:17 +00001528int
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001529_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1530 struct _PyArg_Parser *parser, ...)
1531{
1532 int retval;
1533 va_list va;
1534
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001535 va_start(va, parser);
1536 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1537 va_end(va);
1538 return retval;
1539}
1540
1541int
1542_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1543 struct _PyArg_Parser *parser, ...)
1544{
1545 int retval;
1546 va_list va;
1547
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001548 va_start(va, parser);
1549 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1550 va_end(va);
1551 return retval;
1552}
1553
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001554int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001555_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001556 struct _PyArg_Parser *parser, ...)
1557{
1558 int retval;
1559 va_list va;
1560
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001561 va_start(va, parser);
1562 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1563 va_end(va);
1564 return retval;
1565}
1566
1567int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001568_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001569 struct _PyArg_Parser *parser, ...)
1570{
1571 int retval;
1572 va_list va;
1573
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001574 va_start(va, parser);
1575 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1576 va_end(va);
1577 return retval;
1578}
1579
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001580
1581int
1582_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1583 struct _PyArg_Parser *parser, va_list va)
1584{
1585 int retval;
1586 va_list lva;
1587
Benjamin Peterson0c212142016-09-20 20:39:33 -07001588 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001589
1590 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001591 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001592 return retval;
1593}
1594
1595int
1596_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1597 struct _PyArg_Parser *parser, va_list va)
1598{
1599 int retval;
1600 va_list lva;
1601
Benjamin Peterson0c212142016-09-20 20:39:33 -07001602 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001603
1604 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001605 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001606 return retval;
1607}
1608
1609int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001610PyArg_ValidateKeywordArguments(PyObject *kwargs)
1611{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001612 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 PyErr_BadInternalCall();
1614 return 0;
1615 }
1616 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1617 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001618 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001619 return 0;
1620 }
1621 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001622}
1623
Christian Heimes380f7f22008-02-28 11:19:05 +00001624#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001625
Guido van Rossumaa354651996-08-19 19:32:04 +00001626static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001627vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001628 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001630 char msgbuf[512];
1631 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001632 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001633 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001634 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001635 int i, pos, len;
1636 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001637 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001638 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001639 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001640 freelist_t freelist;
1641
1642 freelist.entries = static_entries;
1643 freelist.first_available = 0;
1644 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001647 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 assert(format != NULL);
1649 assert(kwlist != NULL);
1650 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001651
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 /* grab the function name or custom error msg first (mutually exclusive) */
1653 fname = strchr(format, ':');
1654 if (fname) {
1655 fname++;
1656 custom_msg = NULL;
1657 }
1658 else {
1659 custom_msg = strchr(format,';');
1660 if (custom_msg)
1661 custom_msg++;
1662 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001663
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001664 /* scan kwlist and count the number of positional-only parameters */
1665 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1666 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001668 for (len = pos; kwlist[len]; len++) {
1669 if (!*kwlist[len]) {
1670 PyErr_SetString(PyExc_SystemError,
1671 "Empty keyword parameter name");
1672 return cleanreturn(0, &freelist);
1673 }
1674 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001675
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001676 if (len > STATIC_FREELIST_ENTRIES) {
1677 freelist.entries = PyMem_NEW(freelistentry_t, len);
1678 if (freelist.entries == NULL) {
1679 PyErr_NoMemory();
1680 return 0;
1681 }
1682 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001683 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001686 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1687 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001688 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1689 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001690 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001691 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001692 (fname == NULL) ? "function" : fname,
1693 (fname == NULL) ? "" : "()",
1694 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001695 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001696 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001697 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001698 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001699 }
Tim Petersc2f01122001-10-27 07:25:06 +00001700
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001701 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1702 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001703 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001704 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001705 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001706 "Invalid format string (| specified twice)");
1707 return cleanreturn(0, &freelist);
1708 }
1709
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 min = i;
1711 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001712
1713 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001714 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001715 "Invalid format string ($ before |)");
1716 return cleanreturn(0, &freelist);
1717 }
1718 }
1719 if (*format == '$') {
1720 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001721 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001722 "Invalid format string ($ specified twice)");
1723 return cleanreturn(0, &freelist);
1724 }
1725
1726 max = i;
1727 format++;
1728
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001729 if (max < pos) {
1730 PyErr_SetString(PyExc_SystemError,
1731 "Empty parameter name after $");
1732 return cleanreturn(0, &freelist);
1733 }
1734 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001735 /* Now we know the minimal and the maximal numbers of
1736 * positional arguments and can raise an exception with
1737 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001738 break;
1739 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001740 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001741 if (max == 0) {
1742 PyErr_Format(PyExc_TypeError,
1743 "%.200s%s takes no positional arguments",
1744 (fname == NULL) ? "function" : fname,
1745 (fname == NULL) ? "" : "()");
1746 }
1747 else {
1748 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301749 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001750 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001751 (fname == NULL) ? "function" : fname,
1752 (fname == NULL) ? "" : "()",
1753 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301754 max,
1755 max == 1 ? "" : "s",
1756 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001757 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001758 return cleanreturn(0, &freelist);
1759 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 }
1761 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001762 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 "More keyword list entries (%d) than "
1764 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001765 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001766 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001767 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001768 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001769 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001770 }
1771 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001772 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1773 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001774 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001775 }
1776 else if (PyErr_Occurred()) {
1777 return cleanreturn(0, &freelist);
1778 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001779 }
1780 else {
1781 current_arg = NULL;
1782 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001783
1784 if (current_arg) {
1785 msg = convertitem(current_arg, &format, p_va, flags,
1786 levels, msgbuf, sizeof(msgbuf), &freelist);
1787 if (msg) {
1788 seterror(i+1, msg, levels, fname, custom_msg);
1789 return cleanreturn(0, &freelist);
1790 }
1791 continue;
1792 }
1793
1794 if (i < min) {
1795 if (i < pos) {
1796 assert (min == INT_MAX);
1797 assert (max == INT_MAX);
1798 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001799 /* At that moment we still don't know the minimal and
1800 * the maximal numbers of positional arguments. Raising
1801 * an exception is deferred until we encounter | and $
1802 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001803 }
1804 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001805 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1806 "argument '%s' (pos %d)",
1807 (fname == NULL) ? "function" : fname,
1808 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001809 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001810 return cleanreturn(0, &freelist);
1811 }
1812 }
1813 /* current code reports success when all required args
1814 * fulfilled and no keyword args left, with no further
1815 * validation. XXX Maybe skip this in debug build ?
1816 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001817 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001818 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 }
1820 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001821
Leo Ariasc3d95082018-02-03 18:36:10 -06001822 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 * keyword args */
1824 msg = skipitem(&format, p_va, flags);
1825 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001826 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001827 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001828 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 }
1830 }
Tim Petersb054be42001-10-27 05:07:41 +00001831
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001832 if (skip) {
1833 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301834 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001835 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001836 (fname == NULL) ? "function" : fname,
1837 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001838 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301839 Py_MIN(pos, min),
1840 Py_MIN(pos, min) == 1 ? "" : "s",
1841 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001842 return cleanreturn(0, &freelist);
1843 }
1844
Larry Hastings83a9f482012-03-20 20:06:16 +00001845 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001846 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001847 "more argument specifiers than keyword list entries "
1848 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001849 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 }
Tim Petersc2f01122001-10-27 07:25:06 +00001851
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001852 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001853 PyObject *key;
1854 Py_ssize_t j;
1855 /* make sure there are no arguments given by name and position */
1856 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001857 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001858 if (current_arg) {
1859 /* arg present in tuple and in dict */
1860 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001861 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001862 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001863 (fname == NULL) ? "function" : fname,
1864 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001865 kwlist[i], i+1);
1866 return cleanreturn(0, &freelist);
1867 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001868 else if (PyErr_Occurred()) {
1869 return cleanreturn(0, &freelist);
1870 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001871 }
1872 /* make sure there are no extraneous keyword arguments */
1873 j = 0;
1874 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001876 if (!PyUnicode_Check(key)) {
1877 PyErr_SetString(PyExc_TypeError,
1878 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001879 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001880 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001881 for (i = pos; i < len; i++) {
1882 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001883 match = 1;
1884 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001885 }
1886 }
1887 if (!match) {
1888 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001889 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001890 "argument for %.200s%s",
1891 key,
1892 (fname == NULL) ? "this function" : fname,
1893 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001894 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001895 }
1896 }
1897 }
1898
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001899 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001900}
1901
1902
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001903/* List of static parsers. */
1904static struct _PyArg_Parser *static_arg_parsers = NULL;
1905
1906static int
1907parser_init(struct _PyArg_Parser *parser)
1908{
1909 const char * const *keywords;
1910 const char *format, *msg;
1911 int i, len, min, max, nkw;
1912 PyObject *kwtuple;
1913
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001914 assert(parser->keywords != NULL);
1915 if (parser->kwtuple != NULL) {
1916 return 1;
1917 }
1918
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001919 keywords = parser->keywords;
1920 /* scan keywords and count the number of positional-only parameters */
1921 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1922 }
1923 parser->pos = i;
1924 /* scan keywords and get greatest possible nbr of args */
1925 for (; keywords[i]; i++) {
1926 if (!*keywords[i]) {
1927 PyErr_SetString(PyExc_SystemError,
1928 "Empty keyword parameter name");
1929 return 0;
1930 }
1931 }
1932 len = i;
1933
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001934 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001935 if (format) {
1936 /* grab the function name or custom error msg first (mutually exclusive) */
1937 parser->fname = strchr(parser->format, ':');
1938 if (parser->fname) {
1939 parser->fname++;
1940 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001941 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001942 else {
1943 parser->custom_msg = strchr(parser->format,';');
1944 if (parser->custom_msg)
1945 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001946 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001947
1948 min = max = INT_MAX;
1949 for (i = 0; i < len; i++) {
1950 if (*format == '|') {
1951 if (min != INT_MAX) {
1952 PyErr_SetString(PyExc_SystemError,
1953 "Invalid format string (| specified twice)");
1954 return 0;
1955 }
1956 if (max != INT_MAX) {
1957 PyErr_SetString(PyExc_SystemError,
1958 "Invalid format string ($ before |)");
1959 return 0;
1960 }
1961 min = i;
1962 format++;
1963 }
1964 if (*format == '$') {
1965 if (max != INT_MAX) {
1966 PyErr_SetString(PyExc_SystemError,
1967 "Invalid format string ($ specified twice)");
1968 return 0;
1969 }
1970 if (i < parser->pos) {
1971 PyErr_SetString(PyExc_SystemError,
1972 "Empty parameter name after $");
1973 return 0;
1974 }
1975 max = i;
1976 format++;
1977 }
1978 if (IS_END_OF_FORMAT(*format)) {
1979 PyErr_Format(PyExc_SystemError,
1980 "More keyword list entries (%d) than "
1981 "format specifiers (%d)", len, i);
1982 return 0;
1983 }
1984
1985 msg = skipitem(&format, NULL, 0);
1986 if (msg) {
1987 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1988 format);
1989 return 0;
1990 }
1991 }
1992 parser->min = Py_MIN(min, len);
1993 parser->max = Py_MIN(max, len);
1994
1995 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001996 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02001997 "more argument specifiers than keyword list entries "
1998 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001999 return 0;
2000 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002001 }
2002
2003 nkw = len - parser->pos;
2004 kwtuple = PyTuple_New(nkw);
2005 if (kwtuple == NULL) {
2006 return 0;
2007 }
2008 keywords = parser->keywords + parser->pos;
2009 for (i = 0; i < nkw; i++) {
2010 PyObject *str = PyUnicode_FromString(keywords[i]);
2011 if (str == NULL) {
2012 Py_DECREF(kwtuple);
2013 return 0;
2014 }
2015 PyUnicode_InternInPlace(&str);
2016 PyTuple_SET_ITEM(kwtuple, i, str);
2017 }
2018 parser->kwtuple = kwtuple;
2019
2020 assert(parser->next == NULL);
2021 parser->next = static_arg_parsers;
2022 static_arg_parsers = parser;
2023 return 1;
2024}
2025
2026static void
2027parser_clear(struct _PyArg_Parser *parser)
2028{
2029 Py_CLEAR(parser->kwtuple);
2030}
2031
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002032static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002033find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002034{
2035 Py_ssize_t i, nkwargs;
2036
2037 nkwargs = PyTuple_GET_SIZE(kwnames);
2038 for (i=0; i < nkwargs; i++) {
2039 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2040
2041 /* ptr==ptr should match in most cases since keyword keys
2042 should be interned strings */
2043 if (kwname == key) {
2044 return kwstack[i];
2045 }
2046 if (!PyUnicode_Check(kwname)) {
2047 /* ignore non-string keyword keys:
Serhiy Storchaka17414412017-01-17 10:07:25 +02002048 an error will be raised below */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002049 continue;
2050 }
2051 if (_PyUnicode_EQ(kwname, key)) {
2052 return kwstack[i];
2053 }
2054 }
2055 return NULL;
2056}
2057
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002058static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002059vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002060 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002061 struct _PyArg_Parser *parser,
2062 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002063{
2064 PyObject *kwtuple;
2065 char msgbuf[512];
2066 int levels[32];
2067 const char *format;
2068 const char *msg;
2069 PyObject *keyword;
2070 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002071 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002072 PyObject *current_arg;
2073 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2074 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002075 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002076
2077 freelist.entries = static_entries;
2078 freelist.first_available = 0;
2079 freelist.entries_malloced = 0;
2080
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002081 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002082 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002083 assert(p_va != NULL);
2084
Victor Stinner80ab22f2017-01-16 23:16:47 +01002085 if (parser == NULL) {
2086 PyErr_BadInternalCall();
2087 return 0;
2088 }
2089
2090 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2091 PyErr_BadInternalCall();
2092 return 0;
2093 }
2094
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002095 if (!parser_init(parser)) {
2096 return 0;
2097 }
2098
2099 kwtuple = parser->kwtuple;
2100 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002101 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002102
2103 if (len > STATIC_FREELIST_ENTRIES) {
2104 freelist.entries = PyMem_NEW(freelistentry_t, len);
2105 if (freelist.entries == NULL) {
2106 PyErr_NoMemory();
2107 return 0;
2108 }
2109 freelist.entries_malloced = 1;
2110 }
2111
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002112 if (kwargs != NULL) {
2113 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002114 }
2115 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002116 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002117 kwstack = args + nargs;
2118 }
2119 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002120 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002121 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002122 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002123 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2124 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002125 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002126 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002127 (parser->fname == NULL) ? "function" : parser->fname,
2128 (parser->fname == NULL) ? "" : "()",
2129 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002130 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002131 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002132 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002133 return cleanreturn(0, &freelist);
2134 }
2135 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002136 if (parser->max == 0) {
2137 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002138 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002139 (parser->fname == NULL) ? "function" : parser->fname,
2140 (parser->fname == NULL) ? "" : "()");
2141 }
2142 else {
2143 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002144 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002145 (parser->fname == NULL) ? "function" : parser->fname,
2146 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002147 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302148 parser->max,
2149 parser->max == 1 ? "" : "s",
2150 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002151 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002152 return cleanreturn(0, &freelist);
2153 }
2154
2155 format = parser->format;
2156 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2157 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002158 if (*format == '|') {
2159 format++;
2160 }
2161 if (*format == '$') {
2162 format++;
2163 }
2164 assert(!IS_END_OF_FORMAT(*format));
2165
Serhiy Storchaka17414412017-01-17 10:07:25 +02002166 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002167 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002168 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002169 else if (nkwargs && i >= pos) {
2170 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002171 if (kwargs != NULL) {
2172 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2173 if (!current_arg && PyErr_Occurred()) {
2174 return cleanreturn(0, &freelist);
2175 }
2176 }
2177 else {
2178 current_arg = find_keyword(kwnames, kwstack, keyword);
2179 }
2180 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002181 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002182 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002183 }
2184 else {
2185 current_arg = NULL;
2186 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002187
2188 if (current_arg) {
2189 msg = convertitem(current_arg, &format, p_va, flags,
2190 levels, msgbuf, sizeof(msgbuf), &freelist);
2191 if (msg) {
2192 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2193 return cleanreturn(0, &freelist);
2194 }
2195 continue;
2196 }
2197
2198 if (i < parser->min) {
2199 /* Less arguments than required */
2200 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002201 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002202 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302203 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002204 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002205 (parser->fname == NULL) ? "function" : parser->fname,
2206 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002207 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302208 min,
2209 min == 1 ? "" : "s",
2210 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002211 }
2212 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002213 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002214 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2215 "argument '%U' (pos %d)",
2216 (parser->fname == NULL) ? "function" : parser->fname,
2217 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002218 keyword, i+1);
2219 }
2220 return cleanreturn(0, &freelist);
2221 }
2222 /* current code reports success when all required args
2223 * fulfilled and no keyword args left, with no further
2224 * validation. XXX Maybe skip this in debug build ?
2225 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002226 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002227 return cleanreturn(1, &freelist);
2228 }
2229
Leo Ariasc3d95082018-02-03 18:36:10 -06002230 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002231 * keyword args */
2232 msg = skipitem(&format, p_va, flags);
2233 assert(msg == NULL);
2234 }
2235
2236 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2237
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002238 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002239 Py_ssize_t j;
2240 /* make sure there are no arguments given by name and position */
2241 for (i = pos; i < nargs; i++) {
2242 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002243 if (kwargs != NULL) {
2244 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2245 if (!current_arg && PyErr_Occurred()) {
2246 return cleanreturn(0, &freelist);
2247 }
2248 }
2249 else {
2250 current_arg = find_keyword(kwnames, kwstack, keyword);
2251 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002252 if (current_arg) {
2253 /* arg present in tuple and in dict */
2254 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002255 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002256 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002257 (parser->fname == NULL) ? "function" : parser->fname,
2258 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002259 keyword, i+1);
2260 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002261 }
2262 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002263 /* make sure there are no extraneous keyword arguments */
2264 j = 0;
2265 while (1) {
2266 int match;
2267 if (kwargs != NULL) {
2268 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2269 break;
2270 }
2271 else {
2272 if (j >= PyTuple_GET_SIZE(kwnames))
2273 break;
2274 keyword = PyTuple_GET_ITEM(kwnames, j);
2275 j++;
2276 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002277
Serhiy Storchaka17414412017-01-17 10:07:25 +02002278 if (!PyUnicode_Check(keyword)) {
2279 PyErr_SetString(PyExc_TypeError,
2280 "keywords must be strings");
2281 return cleanreturn(0, &freelist);
2282 }
2283 match = PySequence_Contains(kwtuple, keyword);
2284 if (match <= 0) {
2285 if (!match) {
2286 PyErr_Format(PyExc_TypeError,
2287 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002288 "argument for %.200s%s",
2289 keyword,
2290 (parser->fname == NULL) ? "this function" : parser->fname,
2291 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002292 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002293 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002294 }
2295 }
2296 }
2297
2298 return cleanreturn(1, &freelist);
2299}
2300
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002301static int
2302vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2303 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2304{
2305 PyObject **stack;
2306 Py_ssize_t nargs;
2307
Victor Stinner80ab22f2017-01-16 23:16:47 +01002308 if (args == NULL
2309 || !PyTuple_Check(args)
2310 || (keywords != NULL && !PyDict_Check(keywords)))
2311 {
2312 PyErr_BadInternalCall();
2313 return 0;
2314 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002315
Victor Stinnerd17a6932018-11-09 16:56:48 +01002316 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002317 nargs = PyTuple_GET_SIZE(args);
2318 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2319 parser, p_va, flags);
2320}
2321
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002322
Serhiy Storchaka31913912019-03-14 10:32:22 +02002323#undef _PyArg_UnpackKeywords
2324
2325PyObject * const *
2326_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2327 PyObject *kwargs, PyObject *kwnames,
2328 struct _PyArg_Parser *parser,
2329 int minpos, int maxpos, int minkw,
2330 PyObject **buf)
2331{
2332 PyObject *kwtuple;
2333 PyObject *keyword;
2334 int i, posonly, minposonly, maxargs;
2335 int reqlimit = minkw ? maxpos + minkw : minpos;
2336 Py_ssize_t nkwargs;
2337 PyObject *current_arg;
2338 PyObject * const *kwstack = NULL;
2339
2340 assert(kwargs == NULL || PyDict_Check(kwargs));
2341 assert(kwargs == NULL || kwnames == NULL);
2342
2343 if (parser == NULL) {
2344 PyErr_BadInternalCall();
2345 return NULL;
2346 }
2347
2348 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2349 PyErr_BadInternalCall();
2350 return NULL;
2351 }
2352
2353 if (args == NULL && nargs == 0) {
2354 args = buf;
2355 }
2356
2357 if (!parser_init(parser)) {
2358 return NULL;
2359 }
2360
2361 kwtuple = parser->kwtuple;
2362 posonly = parser->pos;
2363 minposonly = Py_MIN(posonly, minpos);
2364 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2365
2366 if (kwargs != NULL) {
2367 nkwargs = PyDict_GET_SIZE(kwargs);
2368 }
2369 else if (kwnames != NULL) {
2370 nkwargs = PyTuple_GET_SIZE(kwnames);
2371 kwstack = args + nargs;
2372 }
2373 else {
2374 nkwargs = 0;
2375 }
2376 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2377 /* Fast path. */
2378 return args;
2379 }
2380 if (nargs + nkwargs > maxargs) {
2381 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2382 messages in some special cases (see bpo-31229). */
2383 PyErr_Format(PyExc_TypeError,
2384 "%.200s%s takes at most %d %sargument%s (%zd given)",
2385 (parser->fname == NULL) ? "function" : parser->fname,
2386 (parser->fname == NULL) ? "" : "()",
2387 maxargs,
2388 (nargs == 0) ? "keyword " : "",
2389 (maxargs == 1) ? "" : "s",
2390 nargs + nkwargs);
2391 return NULL;
2392 }
2393 if (nargs > maxpos) {
2394 if (maxpos == 0) {
2395 PyErr_Format(PyExc_TypeError,
2396 "%.200s%s takes no positional arguments",
2397 (parser->fname == NULL) ? "function" : parser->fname,
2398 (parser->fname == NULL) ? "" : "()");
2399 }
2400 else {
2401 PyErr_Format(PyExc_TypeError,
2402 "%.200s%s takes %s %d positional argument%s (%zd given)",
2403 (parser->fname == NULL) ? "function" : parser->fname,
2404 (parser->fname == NULL) ? "" : "()",
2405 (minpos < maxpos) ? "at most" : "exactly",
2406 maxpos,
2407 (maxpos == 1) ? "" : "s",
2408 nargs);
2409 }
2410 return NULL;
2411 }
2412 if (nargs < minposonly) {
2413 PyErr_Format(PyExc_TypeError,
2414 "%.200s%s takes %s %d positional argument%s"
2415 " (%zd given)",
2416 (parser->fname == NULL) ? "function" : parser->fname,
2417 (parser->fname == NULL) ? "" : "()",
2418 minposonly < maxpos ? "at least" : "exactly",
2419 minposonly,
2420 minposonly == 1 ? "" : "s",
2421 nargs);
2422 return NULL;
2423 }
2424
2425 /* copy tuple args */
2426 for (i = 0; i < nargs; i++) {
2427 buf[i] = args[i];
2428 }
2429
2430 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002431 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002432 if (nkwargs) {
2433 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2434 if (kwargs != NULL) {
2435 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2436 if (!current_arg && PyErr_Occurred()) {
2437 return NULL;
2438 }
2439 }
2440 else {
2441 current_arg = find_keyword(kwnames, kwstack, keyword);
2442 }
2443 }
2444 else if (i >= reqlimit) {
2445 break;
2446 }
2447 else {
2448 current_arg = NULL;
2449 }
2450
2451 buf[i] = current_arg;
2452
2453 if (current_arg) {
2454 --nkwargs;
2455 }
2456 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2457 /* Less arguments than required */
2458 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2459 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2460 "argument '%U' (pos %d)",
2461 (parser->fname == NULL) ? "function" : parser->fname,
2462 (parser->fname == NULL) ? "" : "()",
2463 keyword, i+1);
2464 return NULL;
2465 }
2466 }
2467
2468 if (nkwargs > 0) {
2469 Py_ssize_t j;
2470 /* make sure there are no arguments given by name and position */
2471 for (i = posonly; i < nargs; i++) {
2472 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2473 if (kwargs != NULL) {
2474 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2475 if (!current_arg && PyErr_Occurred()) {
2476 return NULL;
2477 }
2478 }
2479 else {
2480 current_arg = find_keyword(kwnames, kwstack, keyword);
2481 }
2482 if (current_arg) {
2483 /* arg present in tuple and in dict */
2484 PyErr_Format(PyExc_TypeError,
2485 "argument for %.200s%s given by name ('%U') "
2486 "and position (%d)",
2487 (parser->fname == NULL) ? "function" : parser->fname,
2488 (parser->fname == NULL) ? "" : "()",
2489 keyword, i+1);
2490 return NULL;
2491 }
2492 }
2493 /* make sure there are no extraneous keyword arguments */
2494 j = 0;
2495 while (1) {
2496 int match;
2497 if (kwargs != NULL) {
2498 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2499 break;
2500 }
2501 else {
2502 if (j >= PyTuple_GET_SIZE(kwnames))
2503 break;
2504 keyword = PyTuple_GET_ITEM(kwnames, j);
2505 j++;
2506 }
2507
2508 if (!PyUnicode_Check(keyword)) {
2509 PyErr_SetString(PyExc_TypeError,
2510 "keywords must be strings");
2511 return NULL;
2512 }
2513 match = PySequence_Contains(kwtuple, keyword);
2514 if (match <= 0) {
2515 if (!match) {
2516 PyErr_Format(PyExc_TypeError,
2517 "'%U' is an invalid keyword "
2518 "argument for %.200s%s",
2519 keyword,
2520 (parser->fname == NULL) ? "this function" : parser->fname,
2521 (parser->fname == NULL) ? "" : "()");
2522 }
2523 return NULL;
2524 }
2525 }
2526 }
2527
2528 return buf;
2529}
2530
2531
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002532static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002533skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002534{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 const char *format = *p_format;
2536 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002537
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002539
Larry Hastingsa3479012012-05-08 23:52:03 -07002540 /*
2541 * codes that take a single data pointer as an argument
2542 * (the type of the pointer is irrelevant)
2543 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002544
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 case 'b': /* byte -- very short int */
2546 case 'B': /* byte as bitfield */
2547 case 'h': /* short int */
2548 case 'H': /* short int as bitfield */
2549 case 'i': /* int */
2550 case 'I': /* int sized bitfield */
2551 case 'l': /* long int */
2552 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002553 case 'L': /* long long */
2554 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002555 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 case 'f': /* float */
2557 case 'd': /* double */
2558 case 'D': /* complex double */
2559 case 'c': /* char */
2560 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002561 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002562 case 'S': /* string object */
2563 case 'Y': /* string object */
2564 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002566 if (p_va != NULL) {
2567 (void) va_arg(*p_va, void *);
2568 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002569 break;
2570 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002571
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002573
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002574 case 'e': /* string with encoding */
2575 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002576 if (p_va != NULL) {
2577 (void) va_arg(*p_va, const char *);
2578 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 if (!(*format == 's' || *format == 't'))
2580 /* after 'e', only 's' and 't' is allowed */
2581 goto err;
2582 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002583 }
Stefan Krahf432a322017-08-21 13:09:59 +02002584 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 case 's': /* string */
2587 case 'z': /* string or None */
2588 case 'y': /* bytes */
2589 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002590 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 case 'w': /* buffer, read-write */
2592 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002593 if (p_va != NULL) {
2594 (void) va_arg(*p_va, char **);
2595 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002597 if (p_va != NULL) {
2598 if (flags & FLAG_SIZE_T)
2599 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002600 else {
2601 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2602 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2603 return NULL;
2604 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002605 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002606 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002607 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002608 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002609 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2610 && *format == '*')
2611 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002612 format++;
2613 }
2614 break;
2615 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002616
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 case 'O': /* object */
2618 {
2619 if (*format == '!') {
2620 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002621 if (p_va != NULL) {
2622 (void) va_arg(*p_va, PyTypeObject*);
2623 (void) va_arg(*p_va, PyObject **);
2624 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002625 }
2626 else if (*format == '&') {
2627 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002628 if (p_va != NULL) {
2629 (void) va_arg(*p_va, converter);
2630 (void) va_arg(*p_va, void *);
2631 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 format++;
2633 }
2634 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002635 if (p_va != NULL) {
2636 (void) va_arg(*p_va, PyObject **);
2637 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002638 }
2639 break;
2640 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002641
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002642 case '(': /* bypass tuple, not handled at all previously */
2643 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002644 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 for (;;) {
2646 if (*format==')')
2647 break;
2648 if (IS_END_OF_FORMAT(*format))
2649 return "Unmatched left paren in format "
2650 "string";
2651 msg = skipitem(&format, p_va, flags);
2652 if (msg)
2653 return msg;
2654 }
2655 format++;
2656 break;
2657 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002658
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 case ')':
2660 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002662 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002663err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002664 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002665
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002666 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002668 *p_format = format;
2669 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002670}
Fred Drakee4616e62001-10-23 21:09:29 +00002671
2672
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002673#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002674
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002675int
2676_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2677 Py_ssize_t min, Py_ssize_t max)
2678{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002679 assert(min >= 0);
2680 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002681
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002682 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002683 if (name != NULL)
2684 PyErr_Format(
2685 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302686 "%.200s expected %s%zd argument%s, got %zd",
2687 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 else
2689 PyErr_Format(
2690 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302691 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002692 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302693 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002694 return 0;
2695 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002696
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002697 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002698 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002699 }
2700
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002701 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002702 if (name != NULL)
2703 PyErr_Format(
2704 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302705 "%.200s expected %s%zd argument%s, got %zd",
2706 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 else
2708 PyErr_Format(
2709 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302710 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002711 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302712 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002713 return 0;
2714 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002715
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002716 return 1;
2717}
2718
2719static int
2720unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2721 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2722{
2723 Py_ssize_t i;
2724 PyObject **o;
2725
2726 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2727 return 0;
2728 }
2729
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002730 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002731 o = va_arg(vargs, PyObject **);
2732 *o = args[i];
2733 }
2734 return 1;
2735}
2736
2737int
2738PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2739{
2740 PyObject **stack;
2741 Py_ssize_t nargs;
2742 int retval;
2743 va_list vargs;
2744
2745 if (!PyTuple_Check(args)) {
2746 PyErr_SetString(PyExc_SystemError,
2747 "PyArg_UnpackTuple() argument list is not a tuple");
2748 return 0;
2749 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002750 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002751 nargs = PyTuple_GET_SIZE(args);
2752
Raymond Hettinger94230232016-03-26 03:02:48 -07002753#ifdef HAVE_STDARG_PROTOTYPES
2754 va_start(vargs, max);
2755#else
2756 va_start(vargs);
2757#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002758 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002759 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002760 return retval;
2761}
2762
2763int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002764_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002765 Py_ssize_t min, Py_ssize_t max, ...)
2766{
2767 int retval;
2768 va_list vargs;
2769
2770#ifdef HAVE_STDARG_PROTOTYPES
2771 va_start(vargs, max);
2772#else
2773 va_start(vargs);
2774#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002775 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002776 va_end(vargs);
2777 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002778}
Georg Brandl02c42872005-08-26 06:42:30 +00002779
2780
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002781#undef _PyArg_NoKeywords
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002782#undef _PyArg_NoPositional
2783
Georg Brandl02c42872005-08-26 06:42:30 +00002784/* For type constructors that don't take keyword args
2785 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002786 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002787 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002788 */
2789int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002790_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002791{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002792 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002794 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002795 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002796 PyErr_BadInternalCall();
2797 return 0;
2798 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002799 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002800 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002801 }
2802
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002803 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002804 funcname);
2805 return 0;
2806}
2807
2808
2809int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002810_PyArg_NoPositional(const char *funcname, PyObject *args)
2811{
2812 if (args == NULL)
2813 return 1;
2814 if (!PyTuple_CheckExact(args)) {
2815 PyErr_BadInternalCall();
2816 return 0;
2817 }
2818 if (PyTuple_GET_SIZE(args) == 0)
2819 return 1;
2820
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002821 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002822 funcname);
2823 return 0;
2824}
2825
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002826void
2827_PyArg_Fini(void)
2828{
2829 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2830 while (s) {
2831 tmp = s->next;
2832 s->next = NULL;
2833 parser_clear(s);
2834 s = tmp;
2835 }
2836 static_arg_parsers = NULL;
2837}
2838
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002839#ifdef __cplusplus
2840};
2841#endif