blob: c65530d859c32d45a9da2281fd013fdba62cf2a4 [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
Serhiy Storchaka96631dc2019-08-29 18:29:59 +0300613/* Format an error message generated by convertsimple().
614 displayname must be UTF-8 encoded.
615*/
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000616
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200617void
Serhiy Storchaka96631dc2019-08-29 18:29:59 +0300618_PyArg_BadArgument(const char *fname, const char *displayname,
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200619 const char *expected, PyObject *arg)
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200620{
Serhiy Storchaka96631dc2019-08-29 18:29:59 +0300621 PyErr_Format(PyExc_TypeError,
622 "%.200s() %.200s must be %.50s, not %.50s",
623 fname, displayname, expected,
624 arg == Py_None ? "None" : arg->ob_type->tp_name);
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200625}
626
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200627static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000628converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 assert(expected != NULL);
631 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200632 if (expected[0] == '(') {
633 PyOS_snprintf(msgbuf, bufsize,
634 "%.100s", expected);
635 }
636 else {
637 PyOS_snprintf(msgbuf, bufsize,
638 "must be %.50s, not %.50s", expected,
639 arg == Py_None ? "None" : arg->ob_type->tp_name);
640 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000642}
643
644#define CONV_UNICODE "(unicode conversion error)"
645
Guido van Rossum45aecf42006-03-15 04:58:47 +0000646/* Explicitly check for float arguments when integers are expected.
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200647 Return 1 for error, 0 if ok.
648 XXX Should be removed after the end of the deprecation period in
649 _PyLong_FromNbIndexOrNbInt. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000650static int
651float_argument_error(PyObject *arg)
652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 if (PyFloat_Check(arg)) {
654 PyErr_SetString(PyExc_TypeError,
655 "integer argument expected, got float" );
656 return 1;
657 }
658 else
659 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000660}
661
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000662/* Convert a non-tuple argument. Return NULL if conversion went OK,
663 or a string with a message describing the failure. The message is
664 formatted as "must be <desired type>, not <actual type>".
665 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000666 Don't call if a tuple is expected.
667
668 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000669*/
670
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200671static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000672convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400673 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000674{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 /* For # codes */
676#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
677 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
Inada Naokid3c72a22019-03-23 21:04:40 +0900678 else { \
679 if (PyErr_WarnEx(PyExc_DeprecationWarning, \
680 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) { \
681 return NULL; \
682 } \
683 q=va_arg(*p_va, int*); \
684 }
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000685#define STORE_SIZE(s) \
686 if (flags & FLAG_SIZE_T) \
687 *q2=s; \
688 else { \
689 if (INT_MAX < s) { \
690 PyErr_SetString(PyExc_OverflowError, \
691 "size does not fit in an int"); \
692 return converterr("", arg, msgbuf, bufsize); \
693 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200694 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000695 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000696#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000697#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 const char *format = *p_format;
700 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200701 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 case 'b': { /* unsigned byte -- very short int */
706 char *p = va_arg(*p_va, char *);
707 long ival;
708 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000709 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 ival = PyLong_AsLong(arg);
711 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000712 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 else if (ival < 0) {
714 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000715 "unsigned byte integer is less than minimum");
716 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 }
718 else if (ival > UCHAR_MAX) {
719 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000720 "unsigned byte integer is greater than maximum");
721 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 }
723 else
724 *p = (unsigned char) ival;
725 break;
726 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 case 'B': {/* byte sized bitfield - both signed and unsigned
729 values allowed */
730 char *p = va_arg(*p_va, char *);
731 long ival;
732 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000733 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 ival = PyLong_AsUnsignedLongMask(arg);
735 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000736 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 else
738 *p = (unsigned char) ival;
739 break;
740 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 case 'h': {/* signed short int */
743 short *p = va_arg(*p_va, short *);
744 long ival;
745 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000746 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 ival = PyLong_AsLong(arg);
748 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000749 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 else if (ival < SHRT_MIN) {
751 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000752 "signed short integer is less than minimum");
753 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 }
755 else if (ival > SHRT_MAX) {
756 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000757 "signed short integer is greater than maximum");
758 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 }
760 else
761 *p = (short) ival;
762 break;
763 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 case 'H': { /* short int sized bitfield, both signed and
766 unsigned allowed */
767 unsigned short *p = va_arg(*p_va, unsigned short *);
768 long ival;
769 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000770 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 ival = PyLong_AsUnsignedLongMask(arg);
772 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000773 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 else
775 *p = (unsigned short) ival;
776 break;
777 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 case 'i': {/* signed int */
780 int *p = va_arg(*p_va, int *);
781 long ival;
782 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000783 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 ival = PyLong_AsLong(arg);
785 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000786 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 else if (ival > INT_MAX) {
788 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000789 "signed integer is greater than maximum");
790 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 }
792 else if (ival < INT_MIN) {
793 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000794 "signed integer is less than minimum");
795 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 }
797 else
798 *p = ival;
799 break;
800 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 case 'I': { /* int sized bitfield, both signed and
803 unsigned allowed */
804 unsigned int *p = va_arg(*p_va, unsigned int *);
805 unsigned int ival;
806 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000807 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
809 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000810 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 else
812 *p = ival;
813 break;
814 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 case 'n': /* Py_ssize_t */
817 {
818 PyObject *iobj;
819 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
820 Py_ssize_t ival = -1;
821 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000822 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 iobj = PyNumber_Index(arg);
824 if (iobj != NULL) {
825 ival = PyLong_AsSsize_t(iobj);
826 Py_DECREF(iobj);
827 }
828 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000829 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 *p = ival;
831 break;
832 }
833 case 'l': {/* long int */
834 long *p = va_arg(*p_va, long *);
835 long ival;
836 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000837 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 ival = PyLong_AsLong(arg);
839 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000840 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 else
842 *p = ival;
843 break;
844 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 case 'k': { /* long sized bitfield */
847 unsigned long *p = va_arg(*p_va, unsigned long *);
848 unsigned long ival;
849 if (PyLong_Check(arg))
850 ival = PyLong_AsUnsignedLongMask(arg);
851 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200852 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 *p = ival;
854 break;
855 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000856
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700857 case 'L': {/* long long */
858 long long *p = va_arg( *p_va, long long * );
859 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000860 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000861 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700863 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000864 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000865 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 break;
868 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700871 unsigned long long *p = va_arg(*p_va, unsigned long long *);
872 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 if (PyLong_Check(arg))
874 ival = PyLong_AsUnsignedLongLongMask(arg);
875 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200876 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 *p = ival;
878 break;
879 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 case 'f': {/* float */
882 float *p = va_arg(*p_va, float *);
883 double dval = PyFloat_AsDouble(arg);
Raymond Hettinger21161d72019-08-24 19:45:12 -0700884 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000885 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 else
887 *p = (float) dval;
888 break;
889 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 case 'd': {/* double */
892 double *p = va_arg(*p_va, double *);
893 double dval = PyFloat_AsDouble(arg);
Raymond Hettinger21161d72019-08-24 19:45:12 -0700894 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000895 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896 else
897 *p = dval;
898 break;
899 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 case 'D': {/* complex double */
902 Py_complex *p = va_arg(*p_va, Py_complex *);
903 Py_complex cval;
904 cval = PyComplex_AsCComplex(arg);
905 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000906 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 else
908 *p = cval;
909 break;
910 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 case 'c': {/* char */
913 char *p = va_arg(*p_va, char *);
914 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
915 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300916 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
917 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 else
919 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
920 break;
921 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 case 'C': {/* unicode char */
924 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200925 int kind;
926 void *data;
927
928 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200930
931 if (PyUnicode_READY(arg))
932 RETURN_ERR_OCCURRED;
933
934 if (PyUnicode_GET_LENGTH(arg) != 1)
935 return converterr("a unicode character", arg, msgbuf, bufsize);
936
937 kind = PyUnicode_KIND(arg);
938 data = PyUnicode_DATA(arg);
939 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 break;
941 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000942
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700943 case 'p': {/* boolean *p*redicate */
944 int *p = va_arg(*p_va, int *);
945 int val = PyObject_IsTrue(arg);
946 if (val > 0)
947 *p = 1;
948 else if (val == 0)
949 *p = 0;
950 else
951 RETURN_ERR_OCCURRED;
952 break;
953 }
954
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000955 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000957
Serhiy Storchakab757c832014-12-05 22:25:22 +0200958 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200960 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 Py_ssize_t count;
962 if (*format == '*') {
963 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
964 return converterr(buf, arg, msgbuf, bufsize);
965 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400966 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 return converterr(
968 "(cleanup problem)",
969 arg, msgbuf, bufsize);
970 }
971 break;
972 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200973 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 if (count < 0)
975 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000976 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 FETCH_SIZE;
978 STORE_SIZE(count);
979 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000980 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300981 if (strlen(*p) != (size_t)count) {
982 PyErr_SetString(PyExc_ValueError, "embedded null byte");
983 RETURN_ERR_OCCURRED;
984 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 }
986 break;
987 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000988
Serhiy Storchakab757c832014-12-05 22:25:22 +0200989 case 's': /* text string or bytes-like object */
990 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000991 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000993 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000995
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000996 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
998 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200999 Py_ssize_t len;
1000 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1001 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 return converterr(CONV_UNICODE,
1003 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001004 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001006 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001007 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 if (getbuffer(arg, p, &buf) < 0)
1009 return converterr(buf, arg, msgbuf, bufsize);
1010 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001011 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 return converterr(
1013 "(cleanup problem)",
1014 arg, msgbuf, bufsize);
1015 }
1016 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +02001017 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001018 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001019 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001021
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001022 if (c == 'z' && arg == Py_None) {
1023 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 STORE_SIZE(0);
1025 }
1026 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001027 Py_ssize_t len;
1028 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1029 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 return converterr(CONV_UNICODE,
1031 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001032 *p = sarg;
1033 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001035 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001037 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 Py_ssize_t count = convertbuffer(arg, p, &buf);
1039 if (count < 0)
1040 return converterr(buf, arg, msgbuf, bufsize);
1041 STORE_SIZE(count);
1042 }
1043 format++;
1044 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001045 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001046 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001047 Py_ssize_t len;
1048 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001049
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001050 if (c == 'z' && arg == Py_None)
1051 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001053 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1054 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 return converterr(CONV_UNICODE,
1056 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001057 if (strlen(sarg) != (size_t)len) {
1058 PyErr_SetString(PyExc_ValueError, "embedded null character");
1059 RETURN_ERR_OCCURRED;
1060 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001061 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 }
1063 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001064 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 }
1067 break;
1068 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001069
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001070 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1071 case 'Z': /* raw unicode buffer or None */
1072 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001073 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1074
Serhiy Storchakab757c832014-12-05 22:25:22 +02001075 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001076 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001077 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001078
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001079 if (c == 'Z' && arg == Py_None) {
1080 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001081 STORE_SIZE(0);
1082 }
1083 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001084 Py_ssize_t len;
1085 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001086 if (*p == NULL)
1087 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001088 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001089 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001090 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001091 return converterr(c == 'Z' ? "str or None" : "str",
1092 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001093 format++;
1094 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001095 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001096 if (c == 'Z' && arg == Py_None)
1097 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001098 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001099 Py_ssize_t len;
1100 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001101 if (*p == NULL)
1102 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001103 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001104 PyErr_SetString(PyExc_ValueError, "embedded null character");
1105 RETURN_ERR_OCCURRED;
1106 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001107 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001108 return converterr(c == 'Z' ? "str or None" : "str",
1109 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001110 }
1111 break;
1112 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001113
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001114 case 'e': {/* encoded string */
1115 char **buffer;
1116 const char *encoding;
1117 PyObject *s;
1118 int recode_strings;
1119 Py_ssize_t size;
1120 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001122 /* Get 'e' parameter: the encoding name */
1123 encoding = (const char *)va_arg(*p_va, const char *);
1124 if (encoding == NULL)
1125 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001127 /* Get output buffer parameter:
1128 's' (recode all objects via Unicode) or
1129 't' (only recode non-string objects)
1130 */
1131 if (*format == 's')
1132 recode_strings = 1;
1133 else if (*format == 't')
1134 recode_strings = 0;
1135 else
1136 return converterr(
1137 "(unknown parser marker combination)",
1138 arg, msgbuf, bufsize);
1139 buffer = (char **)va_arg(*p_va, char **);
1140 format++;
1141 if (buffer == NULL)
1142 return converterr("(buffer is NULL)",
1143 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001144
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 /* Encode object */
1146 if (!recode_strings &&
1147 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1148 s = arg;
1149 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001150 if (PyBytes_Check(arg)) {
1151 size = PyBytes_GET_SIZE(s);
1152 ptr = PyBytes_AS_STRING(s);
1153 }
1154 else {
1155 size = PyByteArray_GET_SIZE(s);
1156 ptr = PyByteArray_AS_STRING(s);
1157 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001158 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001159 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001160 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001161 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 encoding,
1163 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 if (s == NULL)
1165 return converterr("(encoding failed)",
1166 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001167 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 size = PyBytes_GET_SIZE(s);
1169 ptr = PyBytes_AS_STRING(s);
1170 if (ptr == NULL)
1171 ptr = "";
1172 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001173 else {
1174 return converterr(
1175 recode_strings ? "str" : "str, bytes or bytearray",
1176 arg, msgbuf, bufsize);
1177 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001178
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001179 /* Write output; output is guaranteed to be 0-terminated */
1180 if (*format == '#') {
1181 /* Using buffer length parameter '#':
1182
1183 - if *buffer is NULL, a new buffer of the
1184 needed size is allocated and the data
1185 copied into it; *buffer is updated to point
1186 to the new buffer; the caller is
1187 responsible for PyMem_Free()ing it after
1188 usage
1189
1190 - if *buffer is not NULL, the data is
1191 copied to *buffer; *buffer_len has to be
1192 set to the size of the buffer on input;
1193 buffer overflow is signalled with an error;
1194 buffer has to provide enough room for the
1195 encoded string plus the trailing 0-byte
1196
1197 - in both cases, *buffer_len is updated to
1198 the size of the buffer /excluding/ the
1199 trailing 0-byte
1200
1201 */
1202 FETCH_SIZE;
1203
1204 format++;
1205 if (q == NULL && q2 == NULL) {
1206 Py_DECREF(s);
1207 return converterr(
1208 "(buffer_len is NULL)",
1209 arg, msgbuf, bufsize);
1210 }
1211 if (*buffer == NULL) {
1212 *buffer = PyMem_NEW(char, size + 1);
1213 if (*buffer == NULL) {
1214 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001215 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001216 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001218 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219 Py_DECREF(s);
1220 return converterr(
1221 "(cleanup problem)",
1222 arg, msgbuf, bufsize);
1223 }
1224 } else {
1225 if (size + 1 > BUFFER_LEN) {
1226 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001227 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001228 "encoded string too long "
1229 "(%zd, maximum length %zd)",
1230 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1231 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001232 }
1233 }
1234 memcpy(*buffer, ptr, size+1);
1235 STORE_SIZE(size);
1236 } else {
1237 /* Using a 0-terminated buffer:
1238
1239 - the encoded string has to be 0-terminated
1240 for this variant to work; if it is not, an
1241 error raised
1242
1243 - a new buffer of the needed size is
1244 allocated and the data copied into it;
1245 *buffer is updated to point to the new
1246 buffer; the caller is responsible for
1247 PyMem_Free()ing it after usage
1248
1249 */
1250 if ((Py_ssize_t)strlen(ptr) != size) {
1251 Py_DECREF(s);
1252 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001253 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 arg, msgbuf, bufsize);
1255 }
1256 *buffer = PyMem_NEW(char, size + 1);
1257 if (*buffer == NULL) {
1258 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001259 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001260 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001261 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001262 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 Py_DECREF(s);
1264 return converterr("(cleanup problem)",
1265 arg, msgbuf, bufsize);
1266 }
1267 memcpy(*buffer, ptr, size+1);
1268 }
1269 Py_DECREF(s);
1270 break;
1271 }
1272
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 case 'S': { /* PyBytes object */
1274 PyObject **p = va_arg(*p_va, PyObject **);
1275 if (PyBytes_Check(arg))
1276 *p = arg;
1277 else
1278 return converterr("bytes", arg, msgbuf, bufsize);
1279 break;
1280 }
1281
1282 case 'Y': { /* PyByteArray object */
1283 PyObject **p = va_arg(*p_va, PyObject **);
1284 if (PyByteArray_Check(arg))
1285 *p = arg;
1286 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001287 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001288 break;
1289 }
1290
1291 case 'U': { /* PyUnicode object */
1292 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001293 if (PyUnicode_Check(arg)) {
1294 if (PyUnicode_READY(arg) == -1)
1295 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001297 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298 else
1299 return converterr("str", arg, msgbuf, bufsize);
1300 break;
1301 }
1302
1303 case 'O': { /* object */
1304 PyTypeObject *type;
1305 PyObject **p;
1306 if (*format == '!') {
1307 type = va_arg(*p_va, PyTypeObject*);
1308 p = va_arg(*p_va, PyObject **);
1309 format++;
1310 if (PyType_IsSubtype(arg->ob_type, type))
1311 *p = arg;
1312 else
1313 return converterr(type->tp_name, arg, msgbuf, bufsize);
1314
1315 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 else if (*format == '&') {
1317 typedef int (*converter)(PyObject *, void *);
1318 converter convert = va_arg(*p_va, converter);
1319 void *addr = va_arg(*p_va, void *);
1320 int res;
1321 format++;
1322 if (! (res = (*convert)(arg, addr)))
1323 return converterr("(unspecified)",
1324 arg, msgbuf, bufsize);
1325 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001326 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 return converterr("(cleanup problem)",
1328 arg, msgbuf, bufsize);
1329 }
1330 else {
1331 p = va_arg(*p_va, PyObject **);
1332 *p = arg;
1333 }
1334 break;
1335 }
1336
1337
Victor Stinner25e8ec42010-06-25 00:02:38 +00001338 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001340
Victor Stinner25e8ec42010-06-25 00:02:38 +00001341 if (*format != '*')
1342 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001343 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001344 arg, msgbuf, bufsize);
1345 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346
Victor Stinner25e8ec42010-06-25 00:02:38 +00001347 /* Caller is interested in Py_buffer, and the object
1348 supports it directly. */
1349 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1350 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001351 return converterr("read-write bytes-like object",
1352 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353 }
Victor Stinner8182b712010-07-28 00:40:58 +00001354 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1355 PyBuffer_Release((Py_buffer*)p);
1356 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1357 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001358 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001359 return converterr(
1360 "(cleanup problem)",
1361 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001362 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001363 break;
1364 }
1365
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001366 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001367 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368
1369 }
1370
1371 *p_format = format;
1372 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001373
1374#undef FETCH_SIZE
1375#undef STORE_SIZE
1376#undef BUFFER_LEN
1377#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001378}
Guido van Rossumaa354651996-08-19 19:32:04 +00001379
Martin v. Löwis18e16552006-02-15 17:27:45 +00001380static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001381convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001382{
Victor Stinner5cb62392010-06-06 20:27:51 +00001383 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001384 Py_ssize_t count;
1385 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001386
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001387 *errmsg = NULL;
1388 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001389 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001390 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 return -1;
1392 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001393
Victor Stinner8182b712010-07-28 00:40:58 +00001394 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396 count = view.len;
1397 *p = view.buf;
1398 PyBuffer_Release(&view);
1399 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001400}
Guido van Rossumaa354651996-08-19 19:32:04 +00001401
Martin v. Löwis423be952008-08-13 15:53:07 +00001402static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001403getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001404{
Victor Stinner8182b712010-07-28 00:40:58 +00001405 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001406 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001407 return -1;
1408 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001409 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001410 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001411 *errmsg = "contiguous buffer";
1412 return -1;
1413 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001415}
1416
Guido van Rossumaa354651996-08-19 19:32:04 +00001417/* Support for keyword arguments donated by
1418 Geoff Philbrick <philbric@delphi.hks.com> */
1419
Tim Petersf8cd3e82001-10-27 04:26:57 +00001420/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001421int
1422PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 PyObject *keywords,
1424 const char *format,
1425 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 int retval;
1428 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 if ((args == NULL || !PyTuple_Check(args)) ||
1431 (keywords != NULL && !PyDict_Check(keywords)) ||
1432 format == NULL ||
1433 kwlist == NULL)
1434 {
1435 PyErr_BadInternalCall();
1436 return 0;
1437 }
Tim Peters45772cd2001-10-27 03:58:40 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 va_start(va, kwlist);
1440 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1441 va_end(va);
1442 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001443}
1444
1445int
1446_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 PyObject *keywords,
1448 const char *format,
1449 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001450{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 int retval;
1452 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001453
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001454 if ((args == NULL || !PyTuple_Check(args)) ||
1455 (keywords != NULL && !PyDict_Check(keywords)) ||
1456 format == NULL ||
1457 kwlist == NULL)
1458 {
1459 PyErr_BadInternalCall();
1460 return 0;
1461 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001462
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001463 va_start(va, kwlist);
1464 retval = vgetargskeywords(args, keywords, format,
1465 kwlist, &va, FLAG_SIZE_T);
1466 va_end(va);
1467 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001468}
1469
1470
Brett Cannon711e7d92004-07-10 22:20:32 +00001471int
1472PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001473 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001474 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001475 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001476{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001477 int retval;
1478 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001479
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 if ((args == NULL || !PyTuple_Check(args)) ||
1481 (keywords != NULL && !PyDict_Check(keywords)) ||
1482 format == NULL ||
1483 kwlist == NULL)
1484 {
1485 PyErr_BadInternalCall();
1486 return 0;
1487 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001488
Benjamin Peterson0c212142016-09-20 20:39:33 -07001489 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001492 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001494}
1495
1496int
1497_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001498 PyObject *keywords,
1499 const char *format,
1500 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001501{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001502 int retval;
1503 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001504
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 if ((args == NULL || !PyTuple_Check(args)) ||
1506 (keywords != NULL && !PyDict_Check(keywords)) ||
1507 format == NULL ||
1508 kwlist == NULL)
1509 {
1510 PyErr_BadInternalCall();
1511 return 0;
1512 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001513
Benjamin Peterson0c212142016-09-20 20:39:33 -07001514 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001515
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001516 retval = vgetargskeywords(args, keywords, format,
1517 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001518 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001520}
1521
Benjamin Petersonfb886362010-04-24 18:21:17 +00001522int
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001523_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1524 struct _PyArg_Parser *parser, ...)
1525{
1526 int retval;
1527 va_list va;
1528
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001529 va_start(va, parser);
1530 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1531 va_end(va);
1532 return retval;
1533}
1534
1535int
1536_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1537 struct _PyArg_Parser *parser, ...)
1538{
1539 int retval;
1540 va_list va;
1541
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001542 va_start(va, parser);
1543 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1544 va_end(va);
1545 return retval;
1546}
1547
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001548int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001549_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001550 struct _PyArg_Parser *parser, ...)
1551{
1552 int retval;
1553 va_list va;
1554
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001555 va_start(va, parser);
1556 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1557 va_end(va);
1558 return retval;
1559}
1560
1561int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001562_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001563 struct _PyArg_Parser *parser, ...)
1564{
1565 int retval;
1566 va_list va;
1567
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001568 va_start(va, parser);
1569 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1570 va_end(va);
1571 return retval;
1572}
1573
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001574
1575int
1576_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1577 struct _PyArg_Parser *parser, va_list va)
1578{
1579 int retval;
1580 va_list lva;
1581
Benjamin Peterson0c212142016-09-20 20:39:33 -07001582 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001583
1584 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001585 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001586 return retval;
1587}
1588
1589int
1590_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1591 struct _PyArg_Parser *parser, va_list va)
1592{
1593 int retval;
1594 va_list lva;
1595
Benjamin Peterson0c212142016-09-20 20:39:33 -07001596 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001597
1598 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001599 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001600 return retval;
1601}
1602
1603int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001604PyArg_ValidateKeywordArguments(PyObject *kwargs)
1605{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001606 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 PyErr_BadInternalCall();
1608 return 0;
1609 }
1610 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1611 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001612 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001613 return 0;
1614 }
1615 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001616}
1617
Christian Heimes380f7f22008-02-28 11:19:05 +00001618#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001619
Guido van Rossumaa354651996-08-19 19:32:04 +00001620static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001621vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001622 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001623{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001624 char msgbuf[512];
1625 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001626 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001628 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001629 int i, pos, len;
1630 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001631 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001632 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001633 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001634 freelist_t freelist;
1635
1636 freelist.entries = static_entries;
1637 freelist.first_available = 0;
1638 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001639
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001641 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 assert(format != NULL);
1643 assert(kwlist != NULL);
1644 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001645
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 /* grab the function name or custom error msg first (mutually exclusive) */
1647 fname = strchr(format, ':');
1648 if (fname) {
1649 fname++;
1650 custom_msg = NULL;
1651 }
1652 else {
1653 custom_msg = strchr(format,';');
1654 if (custom_msg)
1655 custom_msg++;
1656 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001657
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001658 /* scan kwlist and count the number of positional-only parameters */
1659 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1660 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001661 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001662 for (len = pos; kwlist[len]; len++) {
1663 if (!*kwlist[len]) {
1664 PyErr_SetString(PyExc_SystemError,
1665 "Empty keyword parameter name");
1666 return cleanreturn(0, &freelist);
1667 }
1668 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001669
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001670 if (len > STATIC_FREELIST_ENTRIES) {
1671 freelist.entries = PyMem_NEW(freelistentry_t, len);
1672 if (freelist.entries == NULL) {
1673 PyErr_NoMemory();
1674 return 0;
1675 }
1676 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001677 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001678
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001679 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001680 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1681 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001682 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1683 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001684 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001685 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 (fname == NULL) ? "function" : fname,
1687 (fname == NULL) ? "" : "()",
1688 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001689 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001690 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001691 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001692 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001693 }
Tim Petersc2f01122001-10-27 07:25:06 +00001694
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001695 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1696 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001697 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001698 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001699 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001700 "Invalid format string (| specified twice)");
1701 return cleanreturn(0, &freelist);
1702 }
1703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 min = i;
1705 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001706
1707 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001708 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001709 "Invalid format string ($ before |)");
1710 return cleanreturn(0, &freelist);
1711 }
1712 }
1713 if (*format == '$') {
1714 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001715 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001716 "Invalid format string ($ specified twice)");
1717 return cleanreturn(0, &freelist);
1718 }
1719
1720 max = i;
1721 format++;
1722
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001723 if (max < pos) {
1724 PyErr_SetString(PyExc_SystemError,
1725 "Empty parameter name after $");
1726 return cleanreturn(0, &freelist);
1727 }
1728 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001729 /* Now we know the minimal and the maximal numbers of
1730 * positional arguments and can raise an exception with
1731 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001732 break;
1733 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001734 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001735 if (max == 0) {
1736 PyErr_Format(PyExc_TypeError,
1737 "%.200s%s takes no positional arguments",
1738 (fname == NULL) ? "function" : fname,
1739 (fname == NULL) ? "" : "()");
1740 }
1741 else {
1742 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301743 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001744 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001745 (fname == NULL) ? "function" : fname,
1746 (fname == NULL) ? "" : "()",
1747 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301748 max,
1749 max == 1 ? "" : "s",
1750 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001751 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001752 return cleanreturn(0, &freelist);
1753 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001754 }
1755 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001756 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001757 "More keyword list entries (%d) than "
1758 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001759 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001760 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001761 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001762 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001763 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001764 }
1765 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001766 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1767 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001768 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001769 }
1770 else if (PyErr_Occurred()) {
1771 return cleanreturn(0, &freelist);
1772 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001773 }
1774 else {
1775 current_arg = NULL;
1776 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001777
1778 if (current_arg) {
1779 msg = convertitem(current_arg, &format, p_va, flags,
1780 levels, msgbuf, sizeof(msgbuf), &freelist);
1781 if (msg) {
1782 seterror(i+1, msg, levels, fname, custom_msg);
1783 return cleanreturn(0, &freelist);
1784 }
1785 continue;
1786 }
1787
1788 if (i < min) {
1789 if (i < pos) {
1790 assert (min == INT_MAX);
1791 assert (max == INT_MAX);
1792 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001793 /* At that moment we still don't know the minimal and
1794 * the maximal numbers of positional arguments. Raising
1795 * an exception is deferred until we encounter | and $
1796 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001797 }
1798 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001799 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1800 "argument '%s' (pos %d)",
1801 (fname == NULL) ? "function" : fname,
1802 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001803 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001804 return cleanreturn(0, &freelist);
1805 }
1806 }
1807 /* current code reports success when all required args
1808 * fulfilled and no keyword args left, with no further
1809 * validation. XXX Maybe skip this in debug build ?
1810 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001811 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001812 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001813 }
1814 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001815
Leo Ariasc3d95082018-02-03 18:36:10 -06001816 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001817 * keyword args */
1818 msg = skipitem(&format, p_va, flags);
1819 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001820 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001821 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001822 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001823 }
1824 }
Tim Petersb054be42001-10-27 05:07:41 +00001825
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001826 if (skip) {
1827 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301828 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001829 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001830 (fname == NULL) ? "function" : fname,
1831 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001832 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301833 Py_MIN(pos, min),
1834 Py_MIN(pos, min) == 1 ? "" : "s",
1835 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001836 return cleanreturn(0, &freelist);
1837 }
1838
Larry Hastings83a9f482012-03-20 20:06:16 +00001839 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001840 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 "more argument specifiers than keyword list entries "
1842 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001843 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 }
Tim Petersc2f01122001-10-27 07:25:06 +00001845
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001846 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001847 PyObject *key;
1848 Py_ssize_t j;
1849 /* make sure there are no arguments given by name and position */
1850 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001851 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001852 if (current_arg) {
1853 /* arg present in tuple and in dict */
1854 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001855 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001856 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001857 (fname == NULL) ? "function" : fname,
1858 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001859 kwlist[i], i+1);
1860 return cleanreturn(0, &freelist);
1861 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001862 else if (PyErr_Occurred()) {
1863 return cleanreturn(0, &freelist);
1864 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001865 }
1866 /* make sure there are no extraneous keyword arguments */
1867 j = 0;
1868 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 if (!PyUnicode_Check(key)) {
1871 PyErr_SetString(PyExc_TypeError,
1872 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001873 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001875 for (i = pos; i < len; i++) {
1876 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001877 match = 1;
1878 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 }
1880 }
1881 if (!match) {
1882 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001883 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001884 "argument for %.200s%s",
1885 key,
1886 (fname == NULL) ? "this function" : fname,
1887 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001888 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001889 }
1890 }
1891 }
1892
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001893 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001894}
1895
1896
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001897/* List of static parsers. */
1898static struct _PyArg_Parser *static_arg_parsers = NULL;
1899
1900static int
1901parser_init(struct _PyArg_Parser *parser)
1902{
1903 const char * const *keywords;
1904 const char *format, *msg;
1905 int i, len, min, max, nkw;
1906 PyObject *kwtuple;
1907
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001908 assert(parser->keywords != NULL);
1909 if (parser->kwtuple != NULL) {
1910 return 1;
1911 }
1912
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001913 keywords = parser->keywords;
1914 /* scan keywords and count the number of positional-only parameters */
1915 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1916 }
1917 parser->pos = i;
1918 /* scan keywords and get greatest possible nbr of args */
1919 for (; keywords[i]; i++) {
1920 if (!*keywords[i]) {
1921 PyErr_SetString(PyExc_SystemError,
1922 "Empty keyword parameter name");
1923 return 0;
1924 }
1925 }
1926 len = i;
1927
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001928 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001929 if (format) {
1930 /* grab the function name or custom error msg first (mutually exclusive) */
1931 parser->fname = strchr(parser->format, ':');
1932 if (parser->fname) {
1933 parser->fname++;
1934 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001935 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001936 else {
1937 parser->custom_msg = strchr(parser->format,';');
1938 if (parser->custom_msg)
1939 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001940 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001941
1942 min = max = INT_MAX;
1943 for (i = 0; i < len; i++) {
1944 if (*format == '|') {
1945 if (min != INT_MAX) {
1946 PyErr_SetString(PyExc_SystemError,
1947 "Invalid format string (| specified twice)");
1948 return 0;
1949 }
1950 if (max != INT_MAX) {
1951 PyErr_SetString(PyExc_SystemError,
1952 "Invalid format string ($ before |)");
1953 return 0;
1954 }
1955 min = i;
1956 format++;
1957 }
1958 if (*format == '$') {
1959 if (max != INT_MAX) {
1960 PyErr_SetString(PyExc_SystemError,
1961 "Invalid format string ($ specified twice)");
1962 return 0;
1963 }
1964 if (i < parser->pos) {
1965 PyErr_SetString(PyExc_SystemError,
1966 "Empty parameter name after $");
1967 return 0;
1968 }
1969 max = i;
1970 format++;
1971 }
1972 if (IS_END_OF_FORMAT(*format)) {
1973 PyErr_Format(PyExc_SystemError,
1974 "More keyword list entries (%d) than "
1975 "format specifiers (%d)", len, i);
1976 return 0;
1977 }
1978
1979 msg = skipitem(&format, NULL, 0);
1980 if (msg) {
1981 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1982 format);
1983 return 0;
1984 }
1985 }
1986 parser->min = Py_MIN(min, len);
1987 parser->max = Py_MIN(max, len);
1988
1989 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001990 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02001991 "more argument specifiers than keyword list entries "
1992 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001993 return 0;
1994 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001995 }
1996
1997 nkw = len - parser->pos;
1998 kwtuple = PyTuple_New(nkw);
1999 if (kwtuple == NULL) {
2000 return 0;
2001 }
2002 keywords = parser->keywords + parser->pos;
2003 for (i = 0; i < nkw; i++) {
2004 PyObject *str = PyUnicode_FromString(keywords[i]);
2005 if (str == NULL) {
2006 Py_DECREF(kwtuple);
2007 return 0;
2008 }
2009 PyUnicode_InternInPlace(&str);
2010 PyTuple_SET_ITEM(kwtuple, i, str);
2011 }
2012 parser->kwtuple = kwtuple;
2013
2014 assert(parser->next == NULL);
2015 parser->next = static_arg_parsers;
2016 static_arg_parsers = parser;
2017 return 1;
2018}
2019
2020static void
2021parser_clear(struct _PyArg_Parser *parser)
2022{
2023 Py_CLEAR(parser->kwtuple);
2024}
2025
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002026static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002027find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002028{
2029 Py_ssize_t i, nkwargs;
2030
2031 nkwargs = PyTuple_GET_SIZE(kwnames);
2032 for (i=0; i < nkwargs; i++) {
2033 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2034
2035 /* ptr==ptr should match in most cases since keyword keys
2036 should be interned strings */
2037 if (kwname == key) {
2038 return kwstack[i];
2039 }
2040 if (!PyUnicode_Check(kwname)) {
2041 /* ignore non-string keyword keys:
Serhiy Storchaka17414412017-01-17 10:07:25 +02002042 an error will be raised below */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002043 continue;
2044 }
2045 if (_PyUnicode_EQ(kwname, key)) {
2046 return kwstack[i];
2047 }
2048 }
2049 return NULL;
2050}
2051
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002052static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002053vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002054 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002055 struct _PyArg_Parser *parser,
2056 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002057{
2058 PyObject *kwtuple;
2059 char msgbuf[512];
2060 int levels[32];
2061 const char *format;
2062 const char *msg;
2063 PyObject *keyword;
2064 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002065 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002066 PyObject *current_arg;
2067 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2068 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002069 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002070
2071 freelist.entries = static_entries;
2072 freelist.first_available = 0;
2073 freelist.entries_malloced = 0;
2074
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002075 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002076 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002077 assert(p_va != NULL);
2078
Victor Stinner80ab22f2017-01-16 23:16:47 +01002079 if (parser == NULL) {
2080 PyErr_BadInternalCall();
2081 return 0;
2082 }
2083
2084 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2085 PyErr_BadInternalCall();
2086 return 0;
2087 }
2088
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002089 if (!parser_init(parser)) {
2090 return 0;
2091 }
2092
2093 kwtuple = parser->kwtuple;
2094 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002095 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002096
2097 if (len > STATIC_FREELIST_ENTRIES) {
2098 freelist.entries = PyMem_NEW(freelistentry_t, len);
2099 if (freelist.entries == NULL) {
2100 PyErr_NoMemory();
2101 return 0;
2102 }
2103 freelist.entries_malloced = 1;
2104 }
2105
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002106 if (kwargs != NULL) {
2107 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002108 }
2109 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002110 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002111 kwstack = args + nargs;
2112 }
2113 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002114 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002115 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002116 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002117 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2118 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002119 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002120 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002121 (parser->fname == NULL) ? "function" : parser->fname,
2122 (parser->fname == NULL) ? "" : "()",
2123 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002124 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002125 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002126 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002127 return cleanreturn(0, &freelist);
2128 }
2129 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002130 if (parser->max == 0) {
2131 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002132 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002133 (parser->fname == NULL) ? "function" : parser->fname,
2134 (parser->fname == NULL) ? "" : "()");
2135 }
2136 else {
2137 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002138 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002139 (parser->fname == NULL) ? "function" : parser->fname,
2140 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002141 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302142 parser->max,
2143 parser->max == 1 ? "" : "s",
2144 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002145 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002146 return cleanreturn(0, &freelist);
2147 }
2148
2149 format = parser->format;
2150 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2151 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002152 if (*format == '|') {
2153 format++;
2154 }
2155 if (*format == '$') {
2156 format++;
2157 }
2158 assert(!IS_END_OF_FORMAT(*format));
2159
Serhiy Storchaka17414412017-01-17 10:07:25 +02002160 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002161 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002162 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002163 else if (nkwargs && i >= pos) {
2164 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002165 if (kwargs != NULL) {
2166 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2167 if (!current_arg && PyErr_Occurred()) {
2168 return cleanreturn(0, &freelist);
2169 }
2170 }
2171 else {
2172 current_arg = find_keyword(kwnames, kwstack, keyword);
2173 }
2174 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002175 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002176 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002177 }
2178 else {
2179 current_arg = NULL;
2180 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002181
2182 if (current_arg) {
2183 msg = convertitem(current_arg, &format, p_va, flags,
2184 levels, msgbuf, sizeof(msgbuf), &freelist);
2185 if (msg) {
2186 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2187 return cleanreturn(0, &freelist);
2188 }
2189 continue;
2190 }
2191
2192 if (i < parser->min) {
2193 /* Less arguments than required */
2194 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002195 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002196 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302197 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002198 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002199 (parser->fname == NULL) ? "function" : parser->fname,
2200 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002201 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302202 min,
2203 min == 1 ? "" : "s",
2204 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002205 }
2206 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002207 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002208 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2209 "argument '%U' (pos %d)",
2210 (parser->fname == NULL) ? "function" : parser->fname,
2211 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002212 keyword, i+1);
2213 }
2214 return cleanreturn(0, &freelist);
2215 }
2216 /* current code reports success when all required args
2217 * fulfilled and no keyword args left, with no further
2218 * validation. XXX Maybe skip this in debug build ?
2219 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002220 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002221 return cleanreturn(1, &freelist);
2222 }
2223
Leo Ariasc3d95082018-02-03 18:36:10 -06002224 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002225 * keyword args */
2226 msg = skipitem(&format, p_va, flags);
2227 assert(msg == NULL);
2228 }
2229
2230 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2231
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002232 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002233 Py_ssize_t j;
2234 /* make sure there are no arguments given by name and position */
2235 for (i = pos; i < nargs; i++) {
2236 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002237 if (kwargs != NULL) {
2238 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2239 if (!current_arg && PyErr_Occurred()) {
2240 return cleanreturn(0, &freelist);
2241 }
2242 }
2243 else {
2244 current_arg = find_keyword(kwnames, kwstack, keyword);
2245 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002246 if (current_arg) {
2247 /* arg present in tuple and in dict */
2248 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002249 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002250 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002251 (parser->fname == NULL) ? "function" : parser->fname,
2252 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002253 keyword, i+1);
2254 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002255 }
2256 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002257 /* make sure there are no extraneous keyword arguments */
2258 j = 0;
2259 while (1) {
2260 int match;
2261 if (kwargs != NULL) {
2262 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2263 break;
2264 }
2265 else {
2266 if (j >= PyTuple_GET_SIZE(kwnames))
2267 break;
2268 keyword = PyTuple_GET_ITEM(kwnames, j);
2269 j++;
2270 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002271
Serhiy Storchaka17414412017-01-17 10:07:25 +02002272 if (!PyUnicode_Check(keyword)) {
2273 PyErr_SetString(PyExc_TypeError,
2274 "keywords must be strings");
2275 return cleanreturn(0, &freelist);
2276 }
2277 match = PySequence_Contains(kwtuple, keyword);
2278 if (match <= 0) {
2279 if (!match) {
2280 PyErr_Format(PyExc_TypeError,
2281 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002282 "argument for %.200s%s",
2283 keyword,
2284 (parser->fname == NULL) ? "this function" : parser->fname,
2285 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002286 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002287 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002288 }
2289 }
2290 }
2291
2292 return cleanreturn(1, &freelist);
2293}
2294
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002295static int
2296vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2297 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2298{
2299 PyObject **stack;
2300 Py_ssize_t nargs;
2301
Victor Stinner80ab22f2017-01-16 23:16:47 +01002302 if (args == NULL
2303 || !PyTuple_Check(args)
2304 || (keywords != NULL && !PyDict_Check(keywords)))
2305 {
2306 PyErr_BadInternalCall();
2307 return 0;
2308 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002309
Victor Stinnerd17a6932018-11-09 16:56:48 +01002310 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002311 nargs = PyTuple_GET_SIZE(args);
2312 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2313 parser, p_va, flags);
2314}
2315
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002316
Serhiy Storchaka31913912019-03-14 10:32:22 +02002317#undef _PyArg_UnpackKeywords
2318
2319PyObject * const *
2320_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2321 PyObject *kwargs, PyObject *kwnames,
2322 struct _PyArg_Parser *parser,
2323 int minpos, int maxpos, int minkw,
2324 PyObject **buf)
2325{
2326 PyObject *kwtuple;
2327 PyObject *keyword;
2328 int i, posonly, minposonly, maxargs;
2329 int reqlimit = minkw ? maxpos + minkw : minpos;
2330 Py_ssize_t nkwargs;
2331 PyObject *current_arg;
2332 PyObject * const *kwstack = NULL;
2333
2334 assert(kwargs == NULL || PyDict_Check(kwargs));
2335 assert(kwargs == NULL || kwnames == NULL);
2336
2337 if (parser == NULL) {
2338 PyErr_BadInternalCall();
2339 return NULL;
2340 }
2341
2342 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2343 PyErr_BadInternalCall();
2344 return NULL;
2345 }
2346
2347 if (args == NULL && nargs == 0) {
2348 args = buf;
2349 }
2350
2351 if (!parser_init(parser)) {
2352 return NULL;
2353 }
2354
2355 kwtuple = parser->kwtuple;
2356 posonly = parser->pos;
2357 minposonly = Py_MIN(posonly, minpos);
2358 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2359
2360 if (kwargs != NULL) {
2361 nkwargs = PyDict_GET_SIZE(kwargs);
2362 }
2363 else if (kwnames != NULL) {
2364 nkwargs = PyTuple_GET_SIZE(kwnames);
2365 kwstack = args + nargs;
2366 }
2367 else {
2368 nkwargs = 0;
2369 }
2370 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2371 /* Fast path. */
2372 return args;
2373 }
2374 if (nargs + nkwargs > maxargs) {
2375 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2376 messages in some special cases (see bpo-31229). */
2377 PyErr_Format(PyExc_TypeError,
2378 "%.200s%s takes at most %d %sargument%s (%zd given)",
2379 (parser->fname == NULL) ? "function" : parser->fname,
2380 (parser->fname == NULL) ? "" : "()",
2381 maxargs,
2382 (nargs == 0) ? "keyword " : "",
2383 (maxargs == 1) ? "" : "s",
2384 nargs + nkwargs);
2385 return NULL;
2386 }
2387 if (nargs > maxpos) {
2388 if (maxpos == 0) {
2389 PyErr_Format(PyExc_TypeError,
2390 "%.200s%s takes no positional arguments",
2391 (parser->fname == NULL) ? "function" : parser->fname,
2392 (parser->fname == NULL) ? "" : "()");
2393 }
2394 else {
2395 PyErr_Format(PyExc_TypeError,
2396 "%.200s%s takes %s %d positional argument%s (%zd given)",
2397 (parser->fname == NULL) ? "function" : parser->fname,
2398 (parser->fname == NULL) ? "" : "()",
2399 (minpos < maxpos) ? "at most" : "exactly",
2400 maxpos,
2401 (maxpos == 1) ? "" : "s",
2402 nargs);
2403 }
2404 return NULL;
2405 }
2406 if (nargs < minposonly) {
2407 PyErr_Format(PyExc_TypeError,
2408 "%.200s%s takes %s %d positional argument%s"
2409 " (%zd given)",
2410 (parser->fname == NULL) ? "function" : parser->fname,
2411 (parser->fname == NULL) ? "" : "()",
2412 minposonly < maxpos ? "at least" : "exactly",
2413 minposonly,
2414 minposonly == 1 ? "" : "s",
2415 nargs);
2416 return NULL;
2417 }
2418
2419 /* copy tuple args */
2420 for (i = 0; i < nargs; i++) {
2421 buf[i] = args[i];
2422 }
2423
2424 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002425 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002426 if (nkwargs) {
2427 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2428 if (kwargs != NULL) {
2429 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2430 if (!current_arg && PyErr_Occurred()) {
2431 return NULL;
2432 }
2433 }
2434 else {
2435 current_arg = find_keyword(kwnames, kwstack, keyword);
2436 }
2437 }
2438 else if (i >= reqlimit) {
2439 break;
2440 }
2441 else {
2442 current_arg = NULL;
2443 }
2444
2445 buf[i] = current_arg;
2446
2447 if (current_arg) {
2448 --nkwargs;
2449 }
2450 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2451 /* Less arguments than required */
2452 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2453 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2454 "argument '%U' (pos %d)",
2455 (parser->fname == NULL) ? "function" : parser->fname,
2456 (parser->fname == NULL) ? "" : "()",
2457 keyword, i+1);
2458 return NULL;
2459 }
2460 }
2461
2462 if (nkwargs > 0) {
2463 Py_ssize_t j;
2464 /* make sure there are no arguments given by name and position */
2465 for (i = posonly; i < nargs; i++) {
2466 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2467 if (kwargs != NULL) {
2468 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2469 if (!current_arg && PyErr_Occurred()) {
2470 return NULL;
2471 }
2472 }
2473 else {
2474 current_arg = find_keyword(kwnames, kwstack, keyword);
2475 }
2476 if (current_arg) {
2477 /* arg present in tuple and in dict */
2478 PyErr_Format(PyExc_TypeError,
2479 "argument for %.200s%s given by name ('%U') "
2480 "and position (%d)",
2481 (parser->fname == NULL) ? "function" : parser->fname,
2482 (parser->fname == NULL) ? "" : "()",
2483 keyword, i+1);
2484 return NULL;
2485 }
2486 }
2487 /* make sure there are no extraneous keyword arguments */
2488 j = 0;
2489 while (1) {
2490 int match;
2491 if (kwargs != NULL) {
2492 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2493 break;
2494 }
2495 else {
2496 if (j >= PyTuple_GET_SIZE(kwnames))
2497 break;
2498 keyword = PyTuple_GET_ITEM(kwnames, j);
2499 j++;
2500 }
2501
2502 if (!PyUnicode_Check(keyword)) {
2503 PyErr_SetString(PyExc_TypeError,
2504 "keywords must be strings");
2505 return NULL;
2506 }
2507 match = PySequence_Contains(kwtuple, keyword);
2508 if (match <= 0) {
2509 if (!match) {
2510 PyErr_Format(PyExc_TypeError,
2511 "'%U' is an invalid keyword "
2512 "argument for %.200s%s",
2513 keyword,
2514 (parser->fname == NULL) ? "this function" : parser->fname,
2515 (parser->fname == NULL) ? "" : "()");
2516 }
2517 return NULL;
2518 }
2519 }
2520 }
2521
2522 return buf;
2523}
2524
2525
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002526static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002527skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002528{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 const char *format = *p_format;
2530 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002531
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002533
Larry Hastingsa3479012012-05-08 23:52:03 -07002534 /*
2535 * codes that take a single data pointer as an argument
2536 * (the type of the pointer is irrelevant)
2537 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 case 'b': /* byte -- very short int */
2540 case 'B': /* byte as bitfield */
2541 case 'h': /* short int */
2542 case 'H': /* short int as bitfield */
2543 case 'i': /* int */
2544 case 'I': /* int sized bitfield */
2545 case 'l': /* long int */
2546 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002547 case 'L': /* long long */
2548 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002549 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 case 'f': /* float */
2551 case 'd': /* double */
2552 case 'D': /* complex double */
2553 case 'c': /* char */
2554 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002555 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002556 case 'S': /* string object */
2557 case 'Y': /* string object */
2558 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002560 if (p_va != NULL) {
2561 (void) va_arg(*p_va, void *);
2562 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002563 break;
2564 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002565
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002567
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 case 'e': /* string with encoding */
2569 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002570 if (p_va != NULL) {
2571 (void) va_arg(*p_va, const char *);
2572 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 if (!(*format == 's' || *format == 't'))
2574 /* after 'e', only 's' and 't' is allowed */
2575 goto err;
2576 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 }
Stefan Krahf432a322017-08-21 13:09:59 +02002578 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002580 case 's': /* string */
2581 case 'z': /* string or None */
2582 case 'y': /* bytes */
2583 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002584 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002585 case 'w': /* buffer, read-write */
2586 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002587 if (p_va != NULL) {
2588 (void) va_arg(*p_va, char **);
2589 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002591 if (p_va != NULL) {
2592 if (flags & FLAG_SIZE_T)
2593 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002594 else {
2595 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2596 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2597 return NULL;
2598 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002599 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002600 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002601 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002602 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002603 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2604 && *format == '*')
2605 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002606 format++;
2607 }
2608 break;
2609 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 case 'O': /* object */
2612 {
2613 if (*format == '!') {
2614 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002615 if (p_va != NULL) {
2616 (void) va_arg(*p_va, PyTypeObject*);
2617 (void) va_arg(*p_va, PyObject **);
2618 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002619 }
2620 else if (*format == '&') {
2621 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002622 if (p_va != NULL) {
2623 (void) va_arg(*p_va, converter);
2624 (void) va_arg(*p_va, void *);
2625 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 format++;
2627 }
2628 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002629 if (p_va != NULL) {
2630 (void) va_arg(*p_va, PyObject **);
2631 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002632 }
2633 break;
2634 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002635
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 case '(': /* bypass tuple, not handled at all previously */
2637 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002638 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002639 for (;;) {
2640 if (*format==')')
2641 break;
2642 if (IS_END_OF_FORMAT(*format))
2643 return "Unmatched left paren in format "
2644 "string";
2645 msg = skipitem(&format, p_va, flags);
2646 if (msg)
2647 return msg;
2648 }
2649 format++;
2650 break;
2651 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002652
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 case ')':
2654 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002655
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002656 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002657err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002658 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002660 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002661
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002662 *p_format = format;
2663 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002664}
Fred Drakee4616e62001-10-23 21:09:29 +00002665
2666
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002667#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002668
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002669int
2670_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2671 Py_ssize_t min, Py_ssize_t max)
2672{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002673 assert(min >= 0);
2674 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002675
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002676 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002677 if (name != NULL)
2678 PyErr_Format(
2679 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302680 "%.200s expected %s%zd argument%s, got %zd",
2681 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 else
2683 PyErr_Format(
2684 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302685 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002686 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302687 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002688 return 0;
2689 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002690
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002691 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002692 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002693 }
2694
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002695 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002696 if (name != NULL)
2697 PyErr_Format(
2698 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302699 "%.200s expected %s%zd argument%s, got %zd",
2700 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002701 else
2702 PyErr_Format(
2703 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302704 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002705 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302706 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002707 return 0;
2708 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002709
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002710 return 1;
2711}
2712
2713static int
2714unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2715 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2716{
2717 Py_ssize_t i;
2718 PyObject **o;
2719
2720 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2721 return 0;
2722 }
2723
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002724 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002725 o = va_arg(vargs, PyObject **);
2726 *o = args[i];
2727 }
2728 return 1;
2729}
2730
2731int
2732PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2733{
2734 PyObject **stack;
2735 Py_ssize_t nargs;
2736 int retval;
2737 va_list vargs;
2738
2739 if (!PyTuple_Check(args)) {
2740 PyErr_SetString(PyExc_SystemError,
2741 "PyArg_UnpackTuple() argument list is not a tuple");
2742 return 0;
2743 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002744 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002745 nargs = PyTuple_GET_SIZE(args);
2746
Raymond Hettinger94230232016-03-26 03:02:48 -07002747#ifdef HAVE_STDARG_PROTOTYPES
2748 va_start(vargs, max);
2749#else
2750 va_start(vargs);
2751#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002752 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002754 return retval;
2755}
2756
2757int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002758_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002759 Py_ssize_t min, Py_ssize_t max, ...)
2760{
2761 int retval;
2762 va_list vargs;
2763
2764#ifdef HAVE_STDARG_PROTOTYPES
2765 va_start(vargs, max);
2766#else
2767 va_start(vargs);
2768#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002769 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002770 va_end(vargs);
2771 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002772}
Georg Brandl02c42872005-08-26 06:42:30 +00002773
2774
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002775#undef _PyArg_NoKeywords
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002776#undef _PyArg_NoPositional
2777
Georg Brandl02c42872005-08-26 06:42:30 +00002778/* For type constructors that don't take keyword args
2779 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002780 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002781 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002782 */
2783int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002784_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002785{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002786 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002787 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002788 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002789 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002790 PyErr_BadInternalCall();
2791 return 0;
2792 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002793 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002794 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002795 }
2796
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002797 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002798 funcname);
2799 return 0;
2800}
2801
2802
2803int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002804_PyArg_NoPositional(const char *funcname, PyObject *args)
2805{
2806 if (args == NULL)
2807 return 1;
2808 if (!PyTuple_CheckExact(args)) {
2809 PyErr_BadInternalCall();
2810 return 0;
2811 }
2812 if (PyTuple_GET_SIZE(args) == 0)
2813 return 1;
2814
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002815 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002816 funcname);
2817 return 0;
2818}
2819
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002820void
2821_PyArg_Fini(void)
2822{
2823 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2824 while (s) {
2825 tmp = s->next;
2826 s->next = NULL;
2827 parser_clear(s);
2828 s = tmp;
2829 }
2830 static_arg_parsers = NULL;
2831}
2832
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002833#ifdef __cplusplus
2834};
2835#endif