blob: d2dba49966d47f0c27a34c306fb32b857b2358d5 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01005#include "pycore_tupleobject.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00006
Guido van Rossumc1d50531996-08-21 23:38:24 +00007#include <ctype.h>
Benjamin Petersona853a8b2017-09-07 11:13:59 -07008#include <float.h>
Guido van Rossumc1d50531996-08-21 23:38:24 +00009
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000010
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000012extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000014int PyArg_Parse(PyObject *, const char *, ...);
15int PyArg_ParseTuple(PyObject *, const char *, ...);
16int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000017
Tim Petersdbd9ba62000-07-09 03:09:57 +000018int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000020int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000021 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000022
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030023int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
24 struct _PyArg_Parser *, ...);
25int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
26 struct _PyArg_Parser *, va_list);
27
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000028#ifdef HAVE_DECLSPEC_DLL
29/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020030PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020031PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010032 const char *format, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020033PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs,
34 PyObject *kwnames,
Benjamin Peterson819a46f2016-09-09 20:45:06 -070035 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020036PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000037PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
38 const char *, char **, ...);
39PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020040PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000041PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
42 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070043
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030044PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
45 struct _PyArg_Parser *, ...);
46PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
47 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000048#endif
49
Martin v. Löwis18e16552006-02-15 17:27:45 +000050#define FLAG_COMPAT 1
51#define FLAG_SIZE_T 2
52
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040053typedef int (*destr_t)(PyObject *, void *);
54
55
56/* Keep track of "objects" that have been allocated or initialized and
57 which will need to be deallocated or cleaned up somehow if overall
58 parsing fails.
59*/
60typedef struct {
61 void *item;
62 destr_t destructor;
63} freelistentry_t;
64
65typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040066 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010067 int first_available;
68 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040069} freelist_t;
70
Antoine Pitrou7056cb22013-02-17 01:04:57 +010071#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072
73/* Forward */
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020074static int vgetargs1_impl(PyObject *args, PyObject *const *stack, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010075 const char *format, va_list *p_va, int flags);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000076static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020077static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020078static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
79 char *, size_t, freelist_t *);
80static const char *converttuple(PyObject *, const char **, va_list *, int,
81 int *, char *, size_t, int, freelist_t *);
82static const char *convertsimple(PyObject *, const char **, va_list *, int,
83 char *, size_t, freelist_t *);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +020084static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020085static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086
Tim Petersdbd9ba62000-07-09 03:09:57 +000087static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030089static int vgetargskeywordsfast(PyObject *, PyObject *,
90 struct _PyArg_Parser *, va_list *, int);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020091static int vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070092 PyObject *keywords, PyObject *kwnames,
93 struct _PyArg_Parser *parser,
94 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020095static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000096
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
105 va_end(va);
106 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000107}
108
Vinay Sajip0b60f642019-10-15 08:26:12 +0100109PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200110_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
121
Fred Drake563dfc22001-10-23 14:41:08 +0000122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 int retval;
126 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 va_start(va, format);
129 retval = vgetargs1(args, format, &va, 0);
130 va_end(va);
131 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000132}
133
Vinay Sajip0b60f642019-10-15 08:26:12 +0100134PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200135_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 int retval;
138 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 va_start(va, format);
141 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
142 va_end(va);
143 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000144}
145
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000146
147int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200148_PyArg_ParseStack(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100149{
150 int retval;
151 va_list va;
152
153 va_start(va, format);
154 retval = vgetargs1_impl(NULL, args, nargs, format, &va, 0);
155 va_end(va);
156 return retval;
157}
158
Vinay Sajip0b60f642019-10-15 08:26:12 +0100159PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200160_PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100161{
162 int retval;
163 va_list va;
164
165 va_start(va, format);
166 retval = vgetargs1_impl(NULL, args, nargs, format, &va, FLAG_SIZE_T);
167 va_end(va);
168 return retval;
169}
170
171
172int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000173PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200176 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000177
Benjamin Peterson0c212142016-09-20 20:39:33 -0700178 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000179
Christian Heimes2f2fee12016-09-21 11:37:27 +0200180 retval = vgetargs1(args, format, &lva, 0);
181 va_end(lva);
182 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000183}
184
Vinay Sajip0b60f642019-10-15 08:26:12 +0100185PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200186_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200189 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000190
Benjamin Peterson0c212142016-09-20 20:39:33 -0700191 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000192
Christian Heimes2f2fee12016-09-21 11:37:27 +0200193 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
194 va_end(lva);
195 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000196}
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000199/* Handle cleanup of allocated memory in case of exception */
200
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400201static int
202cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 if (ptr) {
205 PyMem_FREE(ptr);
206 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000208}
209
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000210static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400211cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000212{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400213 Py_buffer *buf = (Py_buffer *)ptr;
214 if (buf) {
215 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400217 return 0;
218}
219
220static int
221addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
222{
223 int index;
224
225 index = freelist->first_available;
226 freelist->first_available += 1;
227
228 freelist->entries[index].item = ptr;
229 freelist->entries[index].destructor = destructor;
230
231 return 0;
232}
233
234static int
235cleanreturn(int retval, freelist_t *freelist)
236{
237 int index;
238
239 if (retval == 0) {
240 /* A failure occurred, therefore execute all of the cleanup
241 functions.
242 */
243 for (index = 0; index < freelist->first_available; ++index) {
244 freelist->entries[index].destructor(NULL,
245 freelist->entries[index].item);
246 }
247 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100248 if (freelist->entries_malloced)
249 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000251}
252
253
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000254static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200255vgetargs1_impl(PyObject *compat_args, PyObject *const *stack, Py_ssize_t nargs, const char *format,
Victor Stinner6518a932017-01-17 01:29:49 +0100256 va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 char msgbuf[256];
259 int levels[32];
260 const char *fname = NULL;
261 const char *message = NULL;
262 int min = -1;
263 int max = 0;
264 int level = 0;
265 int endfmt = 0;
266 const char *formatsave = format;
Victor Stinner6518a932017-01-17 01:29:49 +0100267 Py_ssize_t i;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200268 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500270 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
271 freelist_t freelist;
272
Victor Stinner6518a932017-01-17 01:29:49 +0100273 assert(nargs == 0 || stack != NULL);
274
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500275 freelist.entries = static_entries;
276 freelist.first_available = 0;
277 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 while (endfmt == 0) {
282 int c = *format++;
283 switch (c) {
284 case '(':
285 if (level == 0)
286 max++;
287 level++;
288 if (level >= 30)
289 Py_FatalError("too many tuple nesting levels "
290 "in argument format string");
291 break;
292 case ')':
293 if (level == 0)
294 Py_FatalError("excess ')' in getargs format");
295 else
296 level--;
297 break;
298 case '\0':
299 endfmt = 1;
300 break;
301 case ':':
302 fname = format;
303 endfmt = 1;
304 break;
305 case ';':
306 message = format;
307 endfmt = 1;
308 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100309 case '|':
310 if (level == 0)
311 min = max;
312 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 default:
314 if (level == 0) {
Jordon Xu2ec70102019-09-11 00:04:08 +0800315 if (Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 if (c != 'e') /* skip encoded */
317 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
319 break;
320 }
321 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 if (level != 0)
324 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (min < 0)
327 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000330
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100331 if (max > STATIC_FREELIST_ENTRIES) {
332 freelist.entries = PyMem_NEW(freelistentry_t, max);
333 if (freelist.entries == NULL) {
334 PyErr_NoMemory();
335 return 0;
336 }
337 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500338 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 if (compat) {
341 if (max == 0) {
Victor Stinner6518a932017-01-17 01:29:49 +0100342 if (compat_args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100344 PyErr_Format(PyExc_TypeError,
345 "%.200s%s takes no arguments",
346 fname==NULL ? "function" : fname,
347 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400348 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 }
350 else if (min == 1 && max == 1) {
Victor Stinner6518a932017-01-17 01:29:49 +0100351 if (compat_args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100352 PyErr_Format(PyExc_TypeError,
353 "%.200s%s takes at least one argument",
354 fname==NULL ? "function" : fname,
355 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400356 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 }
Victor Stinner6518a932017-01-17 01:29:49 +0100358 msg = convertitem(compat_args, &format, p_va, flags, levels,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 msgbuf, sizeof(msgbuf), &freelist);
360 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400361 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400363 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 }
365 else {
366 PyErr_SetString(PyExc_SystemError,
367 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400368 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 }
370 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000371
Victor Stinner6518a932017-01-17 01:29:49 +0100372 if (nargs < min || max < nargs) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100373 if (message == NULL)
374 PyErr_Format(PyExc_TypeError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200375 "%.150s%s takes %s %d argument%s (%zd given)",
Victor Stinner6ced7c42011-03-21 18:15:42 +0100376 fname==NULL ? "function" : fname,
377 fname==NULL ? "" : "()",
378 min==max ? "exactly"
Victor Stinner6518a932017-01-17 01:29:49 +0100379 : nargs < min ? "at least" : "at most",
380 nargs < min ? min : max,
381 (nargs < min ? min : max) == 1 ? "" : "s",
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200382 nargs);
Victor Stinner6ced7c42011-03-21 18:15:42 +0100383 else
384 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400385 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000387
Victor Stinner6518a932017-01-17 01:29:49 +0100388 for (i = 0; i < nargs; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (*format == '|')
390 format++;
Victor Stinner6518a932017-01-17 01:29:49 +0100391 msg = convertitem(stack[i], &format, p_va,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 flags, levels, msgbuf,
393 sizeof(msgbuf), &freelist);
394 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200395 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400396 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 }
398 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000399
Jordon Xu2ec70102019-09-11 00:04:08 +0800400 if (*format != '\0' && !Py_ISALPHA(*format) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 *format != '(' &&
402 *format != '|' && *format != ':' && *format != ';') {
403 PyErr_Format(PyExc_SystemError,
404 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400405 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000407
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400408 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000409}
410
Victor Stinner6518a932017-01-17 01:29:49 +0100411static int
412vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
413{
414 PyObject **stack;
415 Py_ssize_t nargs;
416
417 if (!(flags & FLAG_COMPAT)) {
418 assert(args != NULL);
419
420 if (!PyTuple_Check(args)) {
421 PyErr_SetString(PyExc_SystemError,
422 "new style getargs format but argument is not a tuple");
423 return 0;
424 }
425
Victor Stinnerd17a6932018-11-09 16:56:48 +0100426 stack = _PyTuple_ITEMS(args);
Victor Stinner6518a932017-01-17 01:29:49 +0100427 nargs = PyTuple_GET_SIZE(args);
428 }
429 else {
430 stack = NULL;
431 nargs = 0;
432 }
433
434 return vgetargs1_impl(args, stack, nargs, format, p_va, flags);
435}
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000436
437
438static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200439seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000440 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 char buf[512];
443 int i;
444 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if (PyErr_Occurred())
447 return;
448 else if (message == NULL) {
449 if (fname != NULL) {
450 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
451 p += strlen(p);
452 }
453 if (iarg != 0) {
454 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Victor Stinnerd36cf5f2020-06-10 18:38:05 +0200455 "argument %zd", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 i = 0;
457 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200458 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000459 PyOS_snprintf(p, sizeof(buf) - (p - buf),
460 ", item %d", levels[i]-1);
461 p += strlen(p);
462 i++;
463 }
464 }
465 else {
466 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
467 p += strlen(p);
468 }
469 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
470 message = buf;
471 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200472 if (msg[0] == '(') {
473 PyErr_SetString(PyExc_SystemError, message);
474 }
475 else {
476 PyErr_SetString(PyExc_TypeError, message);
477 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000478}
479
480
481/* Convert a tuple argument.
482 On entry, *p_format points to the character _after_ the opening '('.
483 On successful exit, *p_format points to the closing ')'.
484 If successful:
485 *p_format and *p_va are updated,
486 *levels and *msgbuf are untouched,
487 and NULL is returned.
488 If the argument is invalid:
489 *p_format is unchanged,
490 *p_va is undefined,
491 *levels is a 0-terminated list of item numbers,
492 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 "must be <typename1>, not <typename2>", where:
494 <typename1> is the name of the expected type, and
495 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000496 and msgbuf is returned.
497*/
498
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200499static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000500converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400502 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 int level = 0;
505 int n = 0;
506 const char *format = *p_format;
507 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100508 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 for (;;) {
511 int c = *format++;
512 if (c == '(') {
513 if (level == 0)
514 n++;
515 level++;
516 }
517 else if (c == ')') {
518 if (level == 0)
519 break;
520 level--;
521 }
522 else if (c == ':' || c == ';' || c == '\0')
523 break;
Jordon Xu2ec70102019-09-11 00:04:08 +0800524 else if (level == 0 && Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 n++;
526 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
529 levels[0] = 0;
530 PyOS_snprintf(msgbuf, bufsize,
531 toplevel ? "expected %d arguments, not %.50s" :
532 "must be %d-item sequence, not %.50s",
533 n,
Victor Stinnera102ed72020-02-07 02:24:48 +0100534 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 return msgbuf;
536 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000537
Victor Stinner74387f52013-11-18 01:21:12 +0100538 len = PySequence_Size(arg);
539 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100541 if (toplevel) {
542 PyOS_snprintf(msgbuf, bufsize,
Victor Stinnerd36cf5f2020-06-10 18:38:05 +0200543 "expected %d argument%s, not %zd",
Xtreak63262782018-12-21 20:15:13 +0530544 n,
545 n == 1 ? "" : "s",
546 len);
Victor Stinner74387f52013-11-18 01:21:12 +0100547 }
548 else {
549 PyOS_snprintf(msgbuf, bufsize,
Victor Stinnerd36cf5f2020-06-10 18:38:05 +0200550 "must be sequence of length %d, not %zd",
Victor Stinner74387f52013-11-18 01:21:12 +0100551 n, len);
552 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000553 return msgbuf;
554 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000556 format = *p_format;
557 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200558 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 PyObject *item;
560 item = PySequence_GetItem(arg, i);
561 if (item == NULL) {
562 PyErr_Clear();
563 levels[0] = i+1;
564 levels[1] = 0;
565 strncpy(msgbuf, "is not retrievable", bufsize);
566 return msgbuf;
567 }
568 msg = convertitem(item, &format, p_va, flags, levels+1,
569 msgbuf, bufsize, freelist);
570 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
571 Py_XDECREF(item);
572 if (msg != NULL) {
573 levels[0] = i+1;
574 return msg;
575 }
576 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 *p_format = format;
579 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000580}
581
582
583/* Convert a single item. */
584
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200585static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000586convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400587 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000588{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200589 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 if (*format == '(' /* ')' */) {
593 format++;
594 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
595 bufsize, 0, freelist);
596 if (msg == NULL)
597 format++;
598 }
599 else {
600 msg = convertsimple(arg, &format, p_va, flags,
601 msgbuf, bufsize, freelist);
602 if (msg != NULL)
603 levels[0] = 0;
604 }
605 if (msg == NULL)
606 *p_format = format;
607 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000608}
609
610
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200612/* Format an error message generated by convertsimple().
613 displayname must be UTF-8 encoded.
614*/
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000615
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200616void
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200617_PyArg_BadArgument(const char *fname, const char *displayname,
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200618 const char *expected, PyObject *arg)
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200619{
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200620 PyErr_Format(PyExc_TypeError,
621 "%.200s() %.200s must be %.50s, not %.50s",
622 fname, displayname, expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100623 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200624}
625
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200626static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000627converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000628{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 assert(expected != NULL);
630 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200631 if (expected[0] == '(') {
632 PyOS_snprintf(msgbuf, bufsize,
633 "%.100s", expected);
634 }
635 else {
636 PyOS_snprintf(msgbuf, bufsize,
637 "must be %.50s, not %.50s", expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100638 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200639 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000641}
642
643#define CONV_UNICODE "(unicode conversion error)"
644
645/* Convert a non-tuple argument. Return NULL if conversion went OK,
646 or a string with a message describing the failure. The message is
647 formatted as "must be <desired type>, not <actual type>".
648 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000649 Don't call if a tuple is expected.
650
651 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000652*/
653
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200654static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000655convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400656 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 /* For # codes */
659#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
660 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
Inada Naokid3c72a22019-03-23 21:04:40 +0900661 else { \
662 if (PyErr_WarnEx(PyExc_DeprecationWarning, \
663 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) { \
664 return NULL; \
665 } \
666 q=va_arg(*p_va, int*); \
667 }
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000668#define STORE_SIZE(s) \
669 if (flags & FLAG_SIZE_T) \
670 *q2=s; \
671 else { \
672 if (INT_MAX < s) { \
673 PyErr_SetString(PyExc_OverflowError, \
674 "size does not fit in an int"); \
675 return converterr("", arg, msgbuf, bufsize); \
676 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200677 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000678 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000679#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000680#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 const char *format = *p_format;
683 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200684 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 case 'b': { /* unsigned byte -- very short int */
689 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300690 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000692 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 else if (ival < 0) {
694 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000695 "unsigned byte integer is less than minimum");
696 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 }
698 else if (ival > UCHAR_MAX) {
699 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000700 "unsigned byte integer is greater than maximum");
701 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000702 }
703 else
704 *p = (unsigned char) ival;
705 break;
706 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 case 'B': {/* byte sized bitfield - both signed and unsigned
709 values allowed */
710 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300711 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
712 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000713 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 else
715 *p = (unsigned char) ival;
716 break;
717 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000719 case 'h': {/* signed short int */
720 short *p = va_arg(*p_va, short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300721 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000723 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 else if (ival < SHRT_MIN) {
725 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000726 "signed short integer is less than minimum");
727 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 }
729 else if (ival > SHRT_MAX) {
730 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000731 "signed short integer is greater than maximum");
732 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 }
734 else
735 *p = (short) ival;
736 break;
737 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 case 'H': { /* short int sized bitfield, both signed and
740 unsigned allowed */
741 unsigned short *p = va_arg(*p_va, unsigned short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300742 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
743 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000744 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 else
746 *p = (unsigned short) ival;
747 break;
748 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 case 'i': {/* signed int */
751 int *p = va_arg(*p_va, int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300752 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000754 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 else if (ival > INT_MAX) {
756 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000757 "signed integer is greater than maximum");
758 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 }
760 else if (ival < INT_MIN) {
761 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000762 "signed integer is less than minimum");
763 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000764 }
765 else
766 *p = ival;
767 break;
768 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 case 'I': { /* int sized bitfield, both signed and
771 unsigned allowed */
772 unsigned int *p = va_arg(*p_va, unsigned int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300773 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
774 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000775 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 else
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300777 *p = (unsigned int) ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 break;
779 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 case 'n': /* Py_ssize_t */
782 {
783 PyObject *iobj;
784 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
785 Py_ssize_t ival = -1;
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300786 iobj = _PyNumber_Index(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 if (iobj != NULL) {
788 ival = PyLong_AsSsize_t(iobj);
789 Py_DECREF(iobj);
790 }
791 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000792 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 *p = ival;
794 break;
795 }
796 case 'l': {/* long int */
797 long *p = va_arg(*p_va, long *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300798 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000800 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 else
802 *p = ival;
803 break;
804 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 case 'k': { /* long sized bitfield */
807 unsigned long *p = va_arg(*p_va, unsigned long *);
808 unsigned long ival;
809 if (PyLong_Check(arg))
810 ival = PyLong_AsUnsignedLongMask(arg);
811 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200812 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 *p = ival;
814 break;
815 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700817 case 'L': {/* long long */
818 long long *p = va_arg( *p_va, long long * );
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300819 long long ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700820 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000821 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000822 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 break;
825 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700828 unsigned long long *p = va_arg(*p_va, unsigned long long *);
829 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 if (PyLong_Check(arg))
831 ival = PyLong_AsUnsignedLongLongMask(arg);
832 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200833 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 *p = ival;
835 break;
836 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000837
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 case 'f': {/* float */
839 float *p = va_arg(*p_va, float *);
840 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700841 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000842 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 else
844 *p = (float) dval;
845 break;
846 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 case 'd': {/* double */
849 double *p = va_arg(*p_va, double *);
850 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700851 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000852 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 else
854 *p = dval;
855 break;
856 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 case 'D': {/* complex double */
859 Py_complex *p = va_arg(*p_va, Py_complex *);
860 Py_complex cval;
861 cval = PyComplex_AsCComplex(arg);
862 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000863 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 else
865 *p = cval;
866 break;
867 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 case 'c': {/* char */
870 char *p = va_arg(*p_va, char *);
871 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
872 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300873 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
874 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 else
876 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
877 break;
878 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 case 'C': {/* unicode char */
881 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200882 int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +0300883 const void *data;
Victor Stinnere1335c72011-10-04 20:53:03 +0200884
885 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200887
888 if (PyUnicode_READY(arg))
889 RETURN_ERR_OCCURRED;
890
891 if (PyUnicode_GET_LENGTH(arg) != 1)
892 return converterr("a unicode character", arg, msgbuf, bufsize);
893
894 kind = PyUnicode_KIND(arg);
895 data = PyUnicode_DATA(arg);
896 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 break;
898 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000899
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700900 case 'p': {/* boolean *p*redicate */
901 int *p = va_arg(*p_va, int *);
902 int val = PyObject_IsTrue(arg);
903 if (val > 0)
904 *p = 1;
905 else if (val == 0)
906 *p = 0;
907 else
908 RETURN_ERR_OCCURRED;
909 break;
910 }
911
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000912 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000914
Serhiy Storchakab757c832014-12-05 22:25:22 +0200915 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200917 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 Py_ssize_t count;
919 if (*format == '*') {
920 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
921 return converterr(buf, arg, msgbuf, bufsize);
922 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400923 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 return converterr(
925 "(cleanup problem)",
926 arg, msgbuf, bufsize);
927 }
928 break;
929 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200930 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 if (count < 0)
932 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000933 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 FETCH_SIZE;
935 STORE_SIZE(count);
936 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000937 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300938 if (strlen(*p) != (size_t)count) {
939 PyErr_SetString(PyExc_ValueError, "embedded null byte");
940 RETURN_ERR_OCCURRED;
941 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 }
943 break;
944 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000945
Serhiy Storchakab757c832014-12-05 22:25:22 +0200946 case 's': /* text string or bytes-like object */
947 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000948 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000950 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000952
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000953 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
955 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200956 Py_ssize_t len;
957 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
958 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 return converterr(CONV_UNICODE,
960 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200961 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200963 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200964 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 if (getbuffer(arg, p, &buf) < 0)
966 return converterr(buf, arg, msgbuf, bufsize);
967 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400968 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 return converterr(
970 "(cleanup problem)",
971 arg, msgbuf, bufsize);
972 }
973 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200974 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000975 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200976 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000978
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000979 if (c == 'z' && arg == Py_None) {
980 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 STORE_SIZE(0);
982 }
983 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200984 Py_ssize_t len;
985 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
986 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 return converterr(CONV_UNICODE,
988 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200989 *p = sarg;
990 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200992 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200994 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 Py_ssize_t count = convertbuffer(arg, p, &buf);
996 if (count < 0)
997 return converterr(buf, arg, msgbuf, bufsize);
998 STORE_SIZE(count);
999 }
1000 format++;
1001 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001002 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001003 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001004 Py_ssize_t len;
1005 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001006
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001007 if (c == 'z' && arg == Py_None)
1008 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001010 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1011 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 return converterr(CONV_UNICODE,
1013 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001014 if (strlen(sarg) != (size_t)len) {
1015 PyErr_SetString(PyExc_ValueError, "embedded null character");
1016 RETURN_ERR_OCCURRED;
1017 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001018 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 }
1020 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001021 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 }
1024 break;
1025 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001026
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001027 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1028 case 'Z': /* raw unicode buffer or None */
1029 {
Brett Cannonb94767f2011-02-22 20:15:44 +00001030 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1031
Serhiy Storchakab757c832014-12-05 22:25:22 +02001032 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001033 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001035
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001036 if (c == 'Z' && arg == Py_None) {
1037 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 STORE_SIZE(0);
1039 }
1040 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001041 Py_ssize_t len;
1042 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001043 if (*p == NULL)
1044 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001045 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001046 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001047 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001048 return converterr(c == 'Z' ? "str or None" : "str",
1049 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001050 format++;
1051 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001052 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001053 if (c == 'Z' && arg == Py_None)
1054 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001055 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001056 Py_ssize_t len;
1057 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001058 if (*p == NULL)
1059 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001060 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001061 PyErr_SetString(PyExc_ValueError, "embedded null character");
1062 RETURN_ERR_OCCURRED;
1063 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001064 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001065 return converterr(c == 'Z' ? "str or None" : "str",
1066 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001067 }
1068 break;
1069 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 case 'e': {/* encoded string */
1072 char **buffer;
1073 const char *encoding;
1074 PyObject *s;
1075 int recode_strings;
1076 Py_ssize_t size;
1077 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001079 /* Get 'e' parameter: the encoding name */
1080 encoding = (const char *)va_arg(*p_va, const char *);
1081 if (encoding == NULL)
1082 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001083
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 /* Get output buffer parameter:
1085 's' (recode all objects via Unicode) or
1086 't' (only recode non-string objects)
1087 */
1088 if (*format == 's')
1089 recode_strings = 1;
1090 else if (*format == 't')
1091 recode_strings = 0;
1092 else
1093 return converterr(
1094 "(unknown parser marker combination)",
1095 arg, msgbuf, bufsize);
1096 buffer = (char **)va_arg(*p_va, char **);
1097 format++;
1098 if (buffer == NULL)
1099 return converterr("(buffer is NULL)",
1100 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001101
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001102 /* Encode object */
1103 if (!recode_strings &&
1104 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1105 s = arg;
1106 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001107 if (PyBytes_Check(arg)) {
1108 size = PyBytes_GET_SIZE(s);
1109 ptr = PyBytes_AS_STRING(s);
1110 }
1111 else {
1112 size = PyByteArray_GET_SIZE(s);
1113 ptr = PyByteArray_AS_STRING(s);
1114 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001116 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001118 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 encoding,
1120 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 if (s == NULL)
1122 return converterr("(encoding failed)",
1123 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001124 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 size = PyBytes_GET_SIZE(s);
1126 ptr = PyBytes_AS_STRING(s);
1127 if (ptr == NULL)
1128 ptr = "";
1129 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001130 else {
1131 return converterr(
1132 recode_strings ? "str" : "str, bytes or bytearray",
1133 arg, msgbuf, bufsize);
1134 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001135
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 /* Write output; output is guaranteed to be 0-terminated */
1137 if (*format == '#') {
1138 /* Using buffer length parameter '#':
1139
1140 - if *buffer is NULL, a new buffer of the
1141 needed size is allocated and the data
1142 copied into it; *buffer is updated to point
1143 to the new buffer; the caller is
1144 responsible for PyMem_Free()ing it after
1145 usage
1146
1147 - if *buffer is not NULL, the data is
1148 copied to *buffer; *buffer_len has to be
1149 set to the size of the buffer on input;
1150 buffer overflow is signalled with an error;
1151 buffer has to provide enough room for the
1152 encoded string plus the trailing 0-byte
1153
1154 - in both cases, *buffer_len is updated to
1155 the size of the buffer /excluding/ the
1156 trailing 0-byte
1157
1158 */
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001159 int *q = NULL; Py_ssize_t *q2 = NULL;
1160 if (flags & FLAG_SIZE_T) {
1161 q2 = va_arg(*p_va, Py_ssize_t*);
1162 }
1163 else {
1164 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1165 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1))
1166 {
1167 Py_DECREF(s);
1168 return NULL;
1169 }
1170 q = va_arg(*p_va, int*);
1171 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172
1173 format++;
1174 if (q == NULL && q2 == NULL) {
1175 Py_DECREF(s);
1176 return converterr(
1177 "(buffer_len is NULL)",
1178 arg, msgbuf, bufsize);
1179 }
1180 if (*buffer == NULL) {
1181 *buffer = PyMem_NEW(char, size + 1);
1182 if (*buffer == NULL) {
1183 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001184 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001185 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001186 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001187 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001188 Py_DECREF(s);
1189 return converterr(
1190 "(cleanup problem)",
1191 arg, msgbuf, bufsize);
1192 }
1193 } else {
1194 if (size + 1 > BUFFER_LEN) {
1195 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001196 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001197 "encoded string too long "
1198 "(%zd, maximum length %zd)",
1199 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1200 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001201 }
1202 }
1203 memcpy(*buffer, ptr, size+1);
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001204
1205 if (flags & FLAG_SIZE_T) {
1206 *q2 = size;
1207 }
1208 else {
1209 if (INT_MAX < size) {
1210 Py_DECREF(s);
1211 PyErr_SetString(PyExc_OverflowError,
1212 "size does not fit in an int");
1213 return converterr("", arg, msgbuf, bufsize);
1214 }
1215 *q = (int)size;
1216 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 } else {
1218 /* Using a 0-terminated buffer:
1219
1220 - the encoded string has to be 0-terminated
1221 for this variant to work; if it is not, an
1222 error raised
1223
1224 - a new buffer of the needed size is
1225 allocated and the data copied into it;
1226 *buffer is updated to point to the new
1227 buffer; the caller is responsible for
1228 PyMem_Free()ing it after usage
1229
1230 */
1231 if ((Py_ssize_t)strlen(ptr) != size) {
1232 Py_DECREF(s);
1233 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001234 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 arg, msgbuf, bufsize);
1236 }
1237 *buffer = PyMem_NEW(char, size + 1);
1238 if (*buffer == NULL) {
1239 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001240 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001241 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001242 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001243 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001244 Py_DECREF(s);
1245 return converterr("(cleanup problem)",
1246 arg, msgbuf, bufsize);
1247 }
1248 memcpy(*buffer, ptr, size+1);
1249 }
1250 Py_DECREF(s);
1251 break;
1252 }
1253
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001254 case 'S': { /* PyBytes object */
1255 PyObject **p = va_arg(*p_va, PyObject **);
1256 if (PyBytes_Check(arg))
1257 *p = arg;
1258 else
1259 return converterr("bytes", arg, msgbuf, bufsize);
1260 break;
1261 }
1262
1263 case 'Y': { /* PyByteArray object */
1264 PyObject **p = va_arg(*p_va, PyObject **);
1265 if (PyByteArray_Check(arg))
1266 *p = arg;
1267 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001268 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001269 break;
1270 }
1271
1272 case 'U': { /* PyUnicode object */
1273 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001274 if (PyUnicode_Check(arg)) {
1275 if (PyUnicode_READY(arg) == -1)
1276 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001277 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001278 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 else
1280 return converterr("str", arg, msgbuf, bufsize);
1281 break;
1282 }
1283
1284 case 'O': { /* object */
1285 PyTypeObject *type;
1286 PyObject **p;
1287 if (*format == '!') {
1288 type = va_arg(*p_va, PyTypeObject*);
1289 p = va_arg(*p_va, PyObject **);
1290 format++;
Victor Stinnera102ed72020-02-07 02:24:48 +01001291 if (PyType_IsSubtype(Py_TYPE(arg), type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 *p = arg;
1293 else
1294 return converterr(type->tp_name, arg, msgbuf, bufsize);
1295
1296 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001297 else if (*format == '&') {
1298 typedef int (*converter)(PyObject *, void *);
1299 converter convert = va_arg(*p_va, converter);
1300 void *addr = va_arg(*p_va, void *);
1301 int res;
1302 format++;
1303 if (! (res = (*convert)(arg, addr)))
1304 return converterr("(unspecified)",
1305 arg, msgbuf, bufsize);
1306 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001307 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001308 return converterr("(cleanup problem)",
1309 arg, msgbuf, bufsize);
1310 }
1311 else {
1312 p = va_arg(*p_va, PyObject **);
1313 *p = arg;
1314 }
1315 break;
1316 }
1317
1318
Victor Stinner25e8ec42010-06-25 00:02:38 +00001319 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001321
Victor Stinner25e8ec42010-06-25 00:02:38 +00001322 if (*format != '*')
1323 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001324 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001325 arg, msgbuf, bufsize);
1326 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327
Victor Stinner25e8ec42010-06-25 00:02:38 +00001328 /* Caller is interested in Py_buffer, and the object
1329 supports it directly. */
1330 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1331 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001332 return converterr("read-write bytes-like object",
1333 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 }
Victor Stinner8182b712010-07-28 00:40:58 +00001335 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1336 PyBuffer_Release((Py_buffer*)p);
1337 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1338 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001339 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001340 return converterr(
1341 "(cleanup problem)",
1342 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001343 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 break;
1345 }
1346
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001348 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001349
1350 }
1351
1352 *p_format = format;
1353 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001354
1355#undef FETCH_SIZE
1356#undef STORE_SIZE
1357#undef BUFFER_LEN
1358#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001359}
Guido van Rossumaa354651996-08-19 19:32:04 +00001360
Martin v. Löwis18e16552006-02-15 17:27:45 +00001361static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001362convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001363{
Victor Stinner5cb62392010-06-06 20:27:51 +00001364 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001365 Py_ssize_t count;
1366 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001367
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368 *errmsg = NULL;
1369 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001370 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001371 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 return -1;
1373 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001374
Victor Stinner8182b712010-07-28 00:40:58 +00001375 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 count = view.len;
1378 *p = view.buf;
1379 PyBuffer_Release(&view);
1380 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001381}
Guido van Rossumaa354651996-08-19 19:32:04 +00001382
Martin v. Löwis423be952008-08-13 15:53:07 +00001383static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001384getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001385{
Victor Stinner8182b712010-07-28 00:40:58 +00001386 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001387 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001388 return -1;
1389 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001390 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001391 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001392 *errmsg = "contiguous buffer";
1393 return -1;
1394 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001395 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001396}
1397
Guido van Rossumaa354651996-08-19 19:32:04 +00001398/* Support for keyword arguments donated by
1399 Geoff Philbrick <philbric@delphi.hks.com> */
1400
Tim Petersf8cd3e82001-10-27 04:26:57 +00001401/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001402int
1403PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 PyObject *keywords,
1405 const char *format,
1406 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001407{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 int retval;
1409 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001410
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001411 if ((args == NULL || !PyTuple_Check(args)) ||
1412 (keywords != NULL && !PyDict_Check(keywords)) ||
1413 format == NULL ||
1414 kwlist == NULL)
1415 {
1416 PyErr_BadInternalCall();
1417 return 0;
1418 }
Tim Peters45772cd2001-10-27 03:58:40 +00001419
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001420 va_start(va, kwlist);
1421 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1422 va_end(va);
1423 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001424}
1425
Vinay Sajip0b60f642019-10-15 08:26:12 +01001426PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001427_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 PyObject *keywords,
1429 const char *format,
1430 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001431{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 int retval;
1433 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001434
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 if ((args == NULL || !PyTuple_Check(args)) ||
1436 (keywords != NULL && !PyDict_Check(keywords)) ||
1437 format == NULL ||
1438 kwlist == NULL)
1439 {
1440 PyErr_BadInternalCall();
1441 return 0;
1442 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001443
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 va_start(va, kwlist);
1445 retval = vgetargskeywords(args, keywords, format,
1446 kwlist, &va, FLAG_SIZE_T);
1447 va_end(va);
1448 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001449}
1450
1451
Brett Cannon711e7d92004-07-10 22:20:32 +00001452int
1453PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001454 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001455 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001456 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001457{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 int retval;
1459 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001460
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001461 if ((args == NULL || !PyTuple_Check(args)) ||
1462 (keywords != NULL && !PyDict_Check(keywords)) ||
1463 format == NULL ||
1464 kwlist == NULL)
1465 {
1466 PyErr_BadInternalCall();
1467 return 0;
1468 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001469
Benjamin Peterson0c212142016-09-20 20:39:33 -07001470 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001472 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001473 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001475}
1476
Vinay Sajip0b60f642019-10-15 08:26:12 +01001477PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001478_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 PyObject *keywords,
1480 const char *format,
1481 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001482{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 int retval;
1484 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001485
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001486 if ((args == NULL || !PyTuple_Check(args)) ||
1487 (keywords != NULL && !PyDict_Check(keywords)) ||
1488 format == NULL ||
1489 kwlist == NULL)
1490 {
1491 PyErr_BadInternalCall();
1492 return 0;
1493 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001494
Benjamin Peterson0c212142016-09-20 20:39:33 -07001495 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001496
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 retval = vgetargskeywords(args, keywords, format,
1498 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001499 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001501}
1502
Vinay Sajip0b60f642019-10-15 08:26:12 +01001503PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001504_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1505 struct _PyArg_Parser *parser, ...)
1506{
1507 int retval;
1508 va_list va;
1509
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001510 va_start(va, parser);
1511 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1512 va_end(va);
1513 return retval;
1514}
1515
Vinay Sajip0b60f642019-10-15 08:26:12 +01001516PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001517_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1518 struct _PyArg_Parser *parser, ...)
1519{
1520 int retval;
1521 va_list va;
1522
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001523 va_start(va, parser);
1524 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1525 va_end(va);
1526 return retval;
1527}
1528
Vinay Sajip0b60f642019-10-15 08:26:12 +01001529PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001530_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001531 struct _PyArg_Parser *parser, ...)
1532{
1533 int retval;
1534 va_list va;
1535
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001536 va_start(va, parser);
1537 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1538 va_end(va);
1539 return retval;
1540}
1541
Vinay Sajip0b60f642019-10-15 08:26:12 +01001542PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001543_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001544 struct _PyArg_Parser *parser, ...)
1545{
1546 int retval;
1547 va_list va;
1548
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001549 va_start(va, parser);
1550 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1551 va_end(va);
1552 return retval;
1553}
1554
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001555
Vinay Sajip0b60f642019-10-15 08:26:12 +01001556PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001557_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1558 struct _PyArg_Parser *parser, va_list va)
1559{
1560 int retval;
1561 va_list lva;
1562
Benjamin Peterson0c212142016-09-20 20:39:33 -07001563 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001564
1565 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001566 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001567 return retval;
1568}
1569
Vinay Sajip0b60f642019-10-15 08:26:12 +01001570PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001571_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1572 struct _PyArg_Parser *parser, va_list va)
1573{
1574 int retval;
1575 va_list lva;
1576
Benjamin Peterson0c212142016-09-20 20:39:33 -07001577 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001578
1579 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001580 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001581 return retval;
1582}
1583
1584int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001585PyArg_ValidateKeywordArguments(PyObject *kwargs)
1586{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001587 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 PyErr_BadInternalCall();
1589 return 0;
1590 }
1591 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1592 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001593 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001594 return 0;
1595 }
1596 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001597}
1598
Christian Heimes380f7f22008-02-28 11:19:05 +00001599#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001600
Guido van Rossumaa354651996-08-19 19:32:04 +00001601static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001602vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001603 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001604{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001605 char msgbuf[512];
1606 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001607 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001609 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001610 int i, pos, len;
1611 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001612 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001613 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001614 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001615 freelist_t freelist;
1616
1617 freelist.entries = static_entries;
1618 freelist.first_available = 0;
1619 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001620
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001622 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001623 assert(format != NULL);
1624 assert(kwlist != NULL);
1625 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 /* grab the function name or custom error msg first (mutually exclusive) */
1628 fname = strchr(format, ':');
1629 if (fname) {
1630 fname++;
1631 custom_msg = NULL;
1632 }
1633 else {
1634 custom_msg = strchr(format,';');
1635 if (custom_msg)
1636 custom_msg++;
1637 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001638
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001639 /* scan kwlist and count the number of positional-only parameters */
1640 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1641 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001643 for (len = pos; kwlist[len]; len++) {
1644 if (!*kwlist[len]) {
1645 PyErr_SetString(PyExc_SystemError,
1646 "Empty keyword parameter name");
1647 return cleanreturn(0, &freelist);
1648 }
1649 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001650
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001651 if (len > STATIC_FREELIST_ENTRIES) {
1652 freelist.entries = PyMem_NEW(freelistentry_t, len);
1653 if (freelist.entries == NULL) {
1654 PyErr_NoMemory();
1655 return 0;
1656 }
1657 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001658 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001659
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001660 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001661 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1662 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001663 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1664 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001665 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001666 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001667 (fname == NULL) ? "function" : fname,
1668 (fname == NULL) ? "" : "()",
1669 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001670 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001672 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001673 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 }
Tim Petersc2f01122001-10-27 07:25:06 +00001675
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001676 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1677 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001679 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001680 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001681 "Invalid format string (| specified twice)");
1682 return cleanreturn(0, &freelist);
1683 }
1684
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001685 min = i;
1686 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001687
1688 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001689 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001690 "Invalid format string ($ before |)");
1691 return cleanreturn(0, &freelist);
1692 }
1693 }
1694 if (*format == '$') {
1695 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001696 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001697 "Invalid format string ($ specified twice)");
1698 return cleanreturn(0, &freelist);
1699 }
1700
1701 max = i;
1702 format++;
1703
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001704 if (max < pos) {
1705 PyErr_SetString(PyExc_SystemError,
1706 "Empty parameter name after $");
1707 return cleanreturn(0, &freelist);
1708 }
1709 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001710 /* Now we know the minimal and the maximal numbers of
1711 * positional arguments and can raise an exception with
1712 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001713 break;
1714 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001715 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001716 if (max == 0) {
1717 PyErr_Format(PyExc_TypeError,
1718 "%.200s%s takes no positional arguments",
1719 (fname == NULL) ? "function" : fname,
1720 (fname == NULL) ? "" : "()");
1721 }
1722 else {
1723 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301724 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001725 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001726 (fname == NULL) ? "function" : fname,
1727 (fname == NULL) ? "" : "()",
1728 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301729 max,
1730 max == 1 ? "" : "s",
1731 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001732 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001733 return cleanreturn(0, &freelist);
1734 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001735 }
1736 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001737 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001738 "More keyword list entries (%d) than "
1739 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001740 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001741 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001742 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001743 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001744 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001745 }
1746 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001747 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1748 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001749 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001750 }
1751 else if (PyErr_Occurred()) {
1752 return cleanreturn(0, &freelist);
1753 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001754 }
1755 else {
1756 current_arg = NULL;
1757 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001758
1759 if (current_arg) {
1760 msg = convertitem(current_arg, &format, p_va, flags,
1761 levels, msgbuf, sizeof(msgbuf), &freelist);
1762 if (msg) {
1763 seterror(i+1, msg, levels, fname, custom_msg);
1764 return cleanreturn(0, &freelist);
1765 }
1766 continue;
1767 }
1768
1769 if (i < min) {
1770 if (i < pos) {
1771 assert (min == INT_MAX);
1772 assert (max == INT_MAX);
1773 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001774 /* At that moment we still don't know the minimal and
1775 * the maximal numbers of positional arguments. Raising
1776 * an exception is deferred until we encounter | and $
1777 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001778 }
1779 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001780 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1781 "argument '%s' (pos %d)",
1782 (fname == NULL) ? "function" : fname,
1783 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001784 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001785 return cleanreturn(0, &freelist);
1786 }
1787 }
1788 /* current code reports success when all required args
1789 * fulfilled and no keyword args left, with no further
1790 * validation. XXX Maybe skip this in debug build ?
1791 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001792 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001793 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 }
1795 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001796
Leo Ariasc3d95082018-02-03 18:36:10 -06001797 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 * keyword args */
1799 msg = skipitem(&format, p_va, flags);
1800 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001801 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001803 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001804 }
1805 }
Tim Petersb054be42001-10-27 05:07:41 +00001806
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001807 if (skip) {
1808 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301809 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001810 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001811 (fname == NULL) ? "function" : fname,
1812 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001813 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301814 Py_MIN(pos, min),
1815 Py_MIN(pos, min) == 1 ? "" : "s",
1816 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001817 return cleanreturn(0, &freelist);
1818 }
1819
Larry Hastings83a9f482012-03-20 20:06:16 +00001820 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001821 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001822 "more argument specifiers than keyword list entries "
1823 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001824 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001825 }
Tim Petersc2f01122001-10-27 07:25:06 +00001826
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001827 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001828 PyObject *key;
1829 Py_ssize_t j;
1830 /* make sure there are no arguments given by name and position */
1831 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001832 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001833 if (current_arg) {
1834 /* arg present in tuple and in dict */
1835 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001836 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001837 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001838 (fname == NULL) ? "function" : fname,
1839 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001840 kwlist[i], i+1);
1841 return cleanreturn(0, &freelist);
1842 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001843 else if (PyErr_Occurred()) {
1844 return cleanreturn(0, &freelist);
1845 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001846 }
1847 /* make sure there are no extraneous keyword arguments */
1848 j = 0;
1849 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001851 if (!PyUnicode_Check(key)) {
1852 PyErr_SetString(PyExc_TypeError,
1853 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001854 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001856 for (i = pos; i < len; i++) {
1857 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001858 match = 1;
1859 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001860 }
1861 }
1862 if (!match) {
1863 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001864 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001865 "argument for %.200s%s",
1866 key,
1867 (fname == NULL) ? "this function" : fname,
1868 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001869 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 }
1871 }
1872 }
1873
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001874 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001875}
1876
1877
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001878/* List of static parsers. */
1879static struct _PyArg_Parser *static_arg_parsers = NULL;
1880
1881static int
1882parser_init(struct _PyArg_Parser *parser)
1883{
1884 const char * const *keywords;
1885 const char *format, *msg;
1886 int i, len, min, max, nkw;
1887 PyObject *kwtuple;
1888
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001889 assert(parser->keywords != NULL);
1890 if (parser->kwtuple != NULL) {
1891 return 1;
1892 }
1893
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001894 keywords = parser->keywords;
1895 /* scan keywords and count the number of positional-only parameters */
1896 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1897 }
1898 parser->pos = i;
1899 /* scan keywords and get greatest possible nbr of args */
1900 for (; keywords[i]; i++) {
1901 if (!*keywords[i]) {
1902 PyErr_SetString(PyExc_SystemError,
1903 "Empty keyword parameter name");
1904 return 0;
1905 }
1906 }
1907 len = i;
1908
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001909 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001910 if (format) {
1911 /* grab the function name or custom error msg first (mutually exclusive) */
1912 parser->fname = strchr(parser->format, ':');
1913 if (parser->fname) {
1914 parser->fname++;
1915 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001916 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001917 else {
1918 parser->custom_msg = strchr(parser->format,';');
1919 if (parser->custom_msg)
1920 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001921 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001922
1923 min = max = INT_MAX;
1924 for (i = 0; i < len; i++) {
1925 if (*format == '|') {
1926 if (min != INT_MAX) {
1927 PyErr_SetString(PyExc_SystemError,
1928 "Invalid format string (| specified twice)");
1929 return 0;
1930 }
1931 if (max != INT_MAX) {
1932 PyErr_SetString(PyExc_SystemError,
1933 "Invalid format string ($ before |)");
1934 return 0;
1935 }
1936 min = i;
1937 format++;
1938 }
1939 if (*format == '$') {
1940 if (max != INT_MAX) {
1941 PyErr_SetString(PyExc_SystemError,
1942 "Invalid format string ($ specified twice)");
1943 return 0;
1944 }
1945 if (i < parser->pos) {
1946 PyErr_SetString(PyExc_SystemError,
1947 "Empty parameter name after $");
1948 return 0;
1949 }
1950 max = i;
1951 format++;
1952 }
1953 if (IS_END_OF_FORMAT(*format)) {
1954 PyErr_Format(PyExc_SystemError,
1955 "More keyword list entries (%d) than "
1956 "format specifiers (%d)", len, i);
1957 return 0;
1958 }
1959
1960 msg = skipitem(&format, NULL, 0);
1961 if (msg) {
1962 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1963 format);
1964 return 0;
1965 }
1966 }
1967 parser->min = Py_MIN(min, len);
1968 parser->max = Py_MIN(max, len);
1969
1970 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001971 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02001972 "more argument specifiers than keyword list entries "
1973 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001974 return 0;
1975 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001976 }
1977
1978 nkw = len - parser->pos;
1979 kwtuple = PyTuple_New(nkw);
1980 if (kwtuple == NULL) {
1981 return 0;
1982 }
1983 keywords = parser->keywords + parser->pos;
1984 for (i = 0; i < nkw; i++) {
1985 PyObject *str = PyUnicode_FromString(keywords[i]);
1986 if (str == NULL) {
1987 Py_DECREF(kwtuple);
1988 return 0;
1989 }
1990 PyUnicode_InternInPlace(&str);
1991 PyTuple_SET_ITEM(kwtuple, i, str);
1992 }
1993 parser->kwtuple = kwtuple;
1994
1995 assert(parser->next == NULL);
1996 parser->next = static_arg_parsers;
1997 static_arg_parsers = parser;
1998 return 1;
1999}
2000
2001static void
2002parser_clear(struct _PyArg_Parser *parser)
2003{
2004 Py_CLEAR(parser->kwtuple);
2005}
2006
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002007static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002008find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002009{
2010 Py_ssize_t i, nkwargs;
2011
2012 nkwargs = PyTuple_GET_SIZE(kwnames);
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002013 for (i = 0; i < nkwargs; i++) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002014 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2015
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002016 /* kwname == key will normally find a match in since keyword keys
2017 should be interned strings; if not retry below in a new loop. */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002018 if (kwname == key) {
2019 return kwstack[i];
2020 }
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002021 }
2022
2023 for (i = 0; i < nkwargs; i++) {
2024 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
Jeroen Demeyer05677862019-08-16 12:41:27 +02002025 assert(PyUnicode_Check(kwname));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002026 if (_PyUnicode_EQ(kwname, key)) {
2027 return kwstack[i];
2028 }
2029 }
2030 return NULL;
2031}
2032
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002033static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002034vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002035 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002036 struct _PyArg_Parser *parser,
2037 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002038{
2039 PyObject *kwtuple;
2040 char msgbuf[512];
2041 int levels[32];
2042 const char *format;
2043 const char *msg;
2044 PyObject *keyword;
2045 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002046 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002047 PyObject *current_arg;
2048 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2049 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002050 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002051
2052 freelist.entries = static_entries;
2053 freelist.first_available = 0;
2054 freelist.entries_malloced = 0;
2055
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002056 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002057 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002058 assert(p_va != NULL);
2059
Victor Stinner80ab22f2017-01-16 23:16:47 +01002060 if (parser == NULL) {
2061 PyErr_BadInternalCall();
2062 return 0;
2063 }
2064
2065 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2066 PyErr_BadInternalCall();
2067 return 0;
2068 }
2069
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002070 if (!parser_init(parser)) {
2071 return 0;
2072 }
2073
2074 kwtuple = parser->kwtuple;
2075 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002076 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002077
2078 if (len > STATIC_FREELIST_ENTRIES) {
2079 freelist.entries = PyMem_NEW(freelistentry_t, len);
2080 if (freelist.entries == NULL) {
2081 PyErr_NoMemory();
2082 return 0;
2083 }
2084 freelist.entries_malloced = 1;
2085 }
2086
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002087 if (kwargs != NULL) {
2088 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002089 }
2090 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002091 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002092 kwstack = args + nargs;
2093 }
2094 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002095 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002096 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002097 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002098 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2099 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002100 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002101 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002102 (parser->fname == NULL) ? "function" : parser->fname,
2103 (parser->fname == NULL) ? "" : "()",
2104 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002105 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002106 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002107 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002108 return cleanreturn(0, &freelist);
2109 }
2110 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002111 if (parser->max == 0) {
2112 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002113 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002114 (parser->fname == NULL) ? "function" : parser->fname,
2115 (parser->fname == NULL) ? "" : "()");
2116 }
2117 else {
2118 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002119 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002120 (parser->fname == NULL) ? "function" : parser->fname,
2121 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002122 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302123 parser->max,
2124 parser->max == 1 ? "" : "s",
2125 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002126 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002127 return cleanreturn(0, &freelist);
2128 }
2129
2130 format = parser->format;
2131 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2132 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002133 if (*format == '|') {
2134 format++;
2135 }
2136 if (*format == '$') {
2137 format++;
2138 }
2139 assert(!IS_END_OF_FORMAT(*format));
2140
Serhiy Storchaka17414412017-01-17 10:07:25 +02002141 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002142 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002143 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002144 else if (nkwargs && i >= pos) {
2145 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002146 if (kwargs != NULL) {
2147 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2148 if (!current_arg && PyErr_Occurred()) {
2149 return cleanreturn(0, &freelist);
2150 }
2151 }
2152 else {
2153 current_arg = find_keyword(kwnames, kwstack, keyword);
2154 }
2155 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002156 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002157 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002158 }
2159 else {
2160 current_arg = NULL;
2161 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002162
2163 if (current_arg) {
2164 msg = convertitem(current_arg, &format, p_va, flags,
2165 levels, msgbuf, sizeof(msgbuf), &freelist);
2166 if (msg) {
2167 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2168 return cleanreturn(0, &freelist);
2169 }
2170 continue;
2171 }
2172
2173 if (i < parser->min) {
2174 /* Less arguments than required */
2175 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002176 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002177 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302178 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002179 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002180 (parser->fname == NULL) ? "function" : parser->fname,
2181 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002182 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302183 min,
2184 min == 1 ? "" : "s",
2185 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002186 }
2187 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002188 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002189 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2190 "argument '%U' (pos %d)",
2191 (parser->fname == NULL) ? "function" : parser->fname,
2192 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002193 keyword, i+1);
2194 }
2195 return cleanreturn(0, &freelist);
2196 }
2197 /* current code reports success when all required args
2198 * fulfilled and no keyword args left, with no further
2199 * validation. XXX Maybe skip this in debug build ?
2200 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002201 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002202 return cleanreturn(1, &freelist);
2203 }
2204
Leo Ariasc3d95082018-02-03 18:36:10 -06002205 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002206 * keyword args */
2207 msg = skipitem(&format, p_va, flags);
2208 assert(msg == NULL);
2209 }
2210
2211 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2212
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002213 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002214 Py_ssize_t j;
2215 /* make sure there are no arguments given by name and position */
2216 for (i = pos; i < nargs; i++) {
2217 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002218 if (kwargs != NULL) {
2219 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2220 if (!current_arg && PyErr_Occurred()) {
2221 return cleanreturn(0, &freelist);
2222 }
2223 }
2224 else {
2225 current_arg = find_keyword(kwnames, kwstack, keyword);
2226 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002227 if (current_arg) {
2228 /* arg present in tuple and in dict */
2229 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002230 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002231 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002232 (parser->fname == NULL) ? "function" : parser->fname,
2233 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002234 keyword, i+1);
2235 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002236 }
2237 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002238 /* make sure there are no extraneous keyword arguments */
2239 j = 0;
2240 while (1) {
2241 int match;
2242 if (kwargs != NULL) {
2243 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2244 break;
2245 }
2246 else {
2247 if (j >= PyTuple_GET_SIZE(kwnames))
2248 break;
2249 keyword = PyTuple_GET_ITEM(kwnames, j);
2250 j++;
2251 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002252
Serhiy Storchaka17414412017-01-17 10:07:25 +02002253 match = PySequence_Contains(kwtuple, keyword);
2254 if (match <= 0) {
2255 if (!match) {
2256 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002257 "'%S' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002258 "argument for %.200s%s",
2259 keyword,
2260 (parser->fname == NULL) ? "this function" : parser->fname,
2261 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002262 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002263 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002264 }
2265 }
2266 }
2267
2268 return cleanreturn(1, &freelist);
2269}
2270
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002271static int
2272vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2273 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2274{
2275 PyObject **stack;
2276 Py_ssize_t nargs;
2277
Victor Stinner80ab22f2017-01-16 23:16:47 +01002278 if (args == NULL
2279 || !PyTuple_Check(args)
2280 || (keywords != NULL && !PyDict_Check(keywords)))
2281 {
2282 PyErr_BadInternalCall();
2283 return 0;
2284 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002285
Victor Stinnerd17a6932018-11-09 16:56:48 +01002286 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002287 nargs = PyTuple_GET_SIZE(args);
2288 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2289 parser, p_va, flags);
2290}
2291
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002292
Serhiy Storchaka31913912019-03-14 10:32:22 +02002293#undef _PyArg_UnpackKeywords
2294
2295PyObject * const *
2296_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2297 PyObject *kwargs, PyObject *kwnames,
2298 struct _PyArg_Parser *parser,
2299 int minpos, int maxpos, int minkw,
2300 PyObject **buf)
2301{
2302 PyObject *kwtuple;
2303 PyObject *keyword;
2304 int i, posonly, minposonly, maxargs;
2305 int reqlimit = minkw ? maxpos + minkw : minpos;
2306 Py_ssize_t nkwargs;
2307 PyObject *current_arg;
2308 PyObject * const *kwstack = NULL;
2309
2310 assert(kwargs == NULL || PyDict_Check(kwargs));
2311 assert(kwargs == NULL || kwnames == NULL);
2312
2313 if (parser == NULL) {
2314 PyErr_BadInternalCall();
2315 return NULL;
2316 }
2317
2318 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2319 PyErr_BadInternalCall();
2320 return NULL;
2321 }
2322
2323 if (args == NULL && nargs == 0) {
2324 args = buf;
2325 }
2326
2327 if (!parser_init(parser)) {
2328 return NULL;
2329 }
2330
2331 kwtuple = parser->kwtuple;
2332 posonly = parser->pos;
2333 minposonly = Py_MIN(posonly, minpos);
2334 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2335
2336 if (kwargs != NULL) {
2337 nkwargs = PyDict_GET_SIZE(kwargs);
2338 }
2339 else if (kwnames != NULL) {
2340 nkwargs = PyTuple_GET_SIZE(kwnames);
2341 kwstack = args + nargs;
2342 }
2343 else {
2344 nkwargs = 0;
2345 }
2346 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2347 /* Fast path. */
2348 return args;
2349 }
2350 if (nargs + nkwargs > maxargs) {
2351 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2352 messages in some special cases (see bpo-31229). */
2353 PyErr_Format(PyExc_TypeError,
2354 "%.200s%s takes at most %d %sargument%s (%zd given)",
2355 (parser->fname == NULL) ? "function" : parser->fname,
2356 (parser->fname == NULL) ? "" : "()",
2357 maxargs,
2358 (nargs == 0) ? "keyword " : "",
2359 (maxargs == 1) ? "" : "s",
2360 nargs + nkwargs);
2361 return NULL;
2362 }
2363 if (nargs > maxpos) {
2364 if (maxpos == 0) {
2365 PyErr_Format(PyExc_TypeError,
2366 "%.200s%s takes no positional arguments",
2367 (parser->fname == NULL) ? "function" : parser->fname,
2368 (parser->fname == NULL) ? "" : "()");
2369 }
2370 else {
2371 PyErr_Format(PyExc_TypeError,
2372 "%.200s%s takes %s %d positional argument%s (%zd given)",
2373 (parser->fname == NULL) ? "function" : parser->fname,
2374 (parser->fname == NULL) ? "" : "()",
2375 (minpos < maxpos) ? "at most" : "exactly",
2376 maxpos,
2377 (maxpos == 1) ? "" : "s",
2378 nargs);
2379 }
2380 return NULL;
2381 }
2382 if (nargs < minposonly) {
2383 PyErr_Format(PyExc_TypeError,
2384 "%.200s%s takes %s %d positional argument%s"
2385 " (%zd given)",
2386 (parser->fname == NULL) ? "function" : parser->fname,
2387 (parser->fname == NULL) ? "" : "()",
2388 minposonly < maxpos ? "at least" : "exactly",
2389 minposonly,
2390 minposonly == 1 ? "" : "s",
2391 nargs);
2392 return NULL;
2393 }
2394
2395 /* copy tuple args */
2396 for (i = 0; i < nargs; i++) {
2397 buf[i] = args[i];
2398 }
2399
2400 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002401 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002402 if (nkwargs) {
2403 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2404 if (kwargs != NULL) {
2405 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2406 if (!current_arg && PyErr_Occurred()) {
2407 return NULL;
2408 }
2409 }
2410 else {
2411 current_arg = find_keyword(kwnames, kwstack, keyword);
2412 }
2413 }
2414 else if (i >= reqlimit) {
2415 break;
2416 }
2417 else {
2418 current_arg = NULL;
2419 }
2420
2421 buf[i] = current_arg;
2422
2423 if (current_arg) {
2424 --nkwargs;
2425 }
2426 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2427 /* Less arguments than required */
2428 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2429 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2430 "argument '%U' (pos %d)",
2431 (parser->fname == NULL) ? "function" : parser->fname,
2432 (parser->fname == NULL) ? "" : "()",
2433 keyword, i+1);
2434 return NULL;
2435 }
2436 }
2437
2438 if (nkwargs > 0) {
2439 Py_ssize_t j;
2440 /* make sure there are no arguments given by name and position */
2441 for (i = posonly; i < nargs; i++) {
2442 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2443 if (kwargs != NULL) {
2444 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2445 if (!current_arg && PyErr_Occurred()) {
2446 return NULL;
2447 }
2448 }
2449 else {
2450 current_arg = find_keyword(kwnames, kwstack, keyword);
2451 }
2452 if (current_arg) {
2453 /* arg present in tuple and in dict */
2454 PyErr_Format(PyExc_TypeError,
2455 "argument for %.200s%s given by name ('%U') "
2456 "and position (%d)",
2457 (parser->fname == NULL) ? "function" : parser->fname,
2458 (parser->fname == NULL) ? "" : "()",
2459 keyword, i+1);
2460 return NULL;
2461 }
2462 }
2463 /* make sure there are no extraneous keyword arguments */
2464 j = 0;
2465 while (1) {
2466 int match;
2467 if (kwargs != NULL) {
2468 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2469 break;
2470 }
2471 else {
2472 if (j >= PyTuple_GET_SIZE(kwnames))
2473 break;
2474 keyword = PyTuple_GET_ITEM(kwnames, j);
2475 j++;
2476 }
2477
Serhiy Storchaka31913912019-03-14 10:32:22 +02002478 match = PySequence_Contains(kwtuple, keyword);
2479 if (match <= 0) {
2480 if (!match) {
2481 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002482 "'%S' is an invalid keyword "
Serhiy Storchaka31913912019-03-14 10:32:22 +02002483 "argument for %.200s%s",
2484 keyword,
2485 (parser->fname == NULL) ? "this function" : parser->fname,
2486 (parser->fname == NULL) ? "" : "()");
2487 }
2488 return NULL;
2489 }
2490 }
2491 }
2492
2493 return buf;
2494}
2495
2496
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002497static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002498skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002499{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002500 const char *format = *p_format;
2501 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002502
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002504
Larry Hastingsa3479012012-05-08 23:52:03 -07002505 /*
2506 * codes that take a single data pointer as an argument
2507 * (the type of the pointer is irrelevant)
2508 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002510 case 'b': /* byte -- very short int */
2511 case 'B': /* byte as bitfield */
2512 case 'h': /* short int */
2513 case 'H': /* short int as bitfield */
2514 case 'i': /* int */
2515 case 'I': /* int sized bitfield */
2516 case 'l': /* long int */
2517 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002518 case 'L': /* long long */
2519 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002520 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002521 case 'f': /* float */
2522 case 'd': /* double */
2523 case 'D': /* complex double */
2524 case 'c': /* char */
2525 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002526 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002527 case 'S': /* string object */
2528 case 'Y': /* string object */
2529 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002531 if (p_va != NULL) {
2532 (void) va_arg(*p_va, void *);
2533 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 break;
2535 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002536
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 case 'e': /* string with encoding */
2540 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002541 if (p_va != NULL) {
2542 (void) va_arg(*p_va, const char *);
2543 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002544 if (!(*format == 's' || *format == 't'))
2545 /* after 'e', only 's' and 't' is allowed */
2546 goto err;
2547 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 }
Stefan Krahf432a322017-08-21 13:09:59 +02002549 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 case 's': /* string */
2552 case 'z': /* string or None */
2553 case 'y': /* bytes */
2554 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002555 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 case 'w': /* buffer, read-write */
2557 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002558 if (p_va != NULL) {
2559 (void) va_arg(*p_va, char **);
2560 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002561 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002562 if (p_va != NULL) {
2563 if (flags & FLAG_SIZE_T)
2564 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002565 else {
2566 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2567 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2568 return NULL;
2569 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002570 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002571 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002572 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002573 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002574 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2575 && *format == '*')
2576 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 format++;
2578 }
2579 break;
2580 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002581
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002582 case 'O': /* object */
2583 {
2584 if (*format == '!') {
2585 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002586 if (p_va != NULL) {
2587 (void) va_arg(*p_va, PyTypeObject*);
2588 (void) va_arg(*p_va, PyObject **);
2589 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002590 }
2591 else if (*format == '&') {
2592 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002593 if (p_va != NULL) {
2594 (void) va_arg(*p_va, converter);
2595 (void) va_arg(*p_va, void *);
2596 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002597 format++;
2598 }
2599 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002600 if (p_va != NULL) {
2601 (void) va_arg(*p_va, PyObject **);
2602 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 }
2604 break;
2605 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002606
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 case '(': /* bypass tuple, not handled at all previously */
2608 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002609 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002610 for (;;) {
2611 if (*format==')')
2612 break;
2613 if (IS_END_OF_FORMAT(*format))
2614 return "Unmatched left paren in format "
2615 "string";
2616 msg = skipitem(&format, p_va, flags);
2617 if (msg)
2618 return msg;
2619 }
2620 format++;
2621 break;
2622 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002623
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002624 case ')':
2625 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002626
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002627 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002628err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002629 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002632
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 *p_format = format;
2634 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002635}
Fred Drakee4616e62001-10-23 21:09:29 +00002636
2637
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002638#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002639
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002640int
2641_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2642 Py_ssize_t min, Py_ssize_t max)
2643{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 assert(min >= 0);
2645 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002646
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002647 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002648 if (name != NULL)
2649 PyErr_Format(
2650 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302651 "%.200s expected %s%zd argument%s, got %zd",
2652 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002653 else
2654 PyErr_Format(
2655 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302656 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302658 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002659 return 0;
2660 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002661
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002662 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002663 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002664 }
2665
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002666 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002667 if (name != NULL)
2668 PyErr_Format(
2669 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302670 "%.200s expected %s%zd argument%s, got %zd",
2671 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002672 else
2673 PyErr_Format(
2674 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302675 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002676 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302677 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 return 0;
2679 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002680
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002681 return 1;
2682}
2683
2684static int
2685unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2686 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2687{
2688 Py_ssize_t i;
2689 PyObject **o;
2690
2691 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2692 return 0;
2693 }
2694
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002695 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002696 o = va_arg(vargs, PyObject **);
2697 *o = args[i];
2698 }
2699 return 1;
2700}
2701
2702int
2703PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2704{
2705 PyObject **stack;
2706 Py_ssize_t nargs;
2707 int retval;
2708 va_list vargs;
2709
2710 if (!PyTuple_Check(args)) {
2711 PyErr_SetString(PyExc_SystemError,
2712 "PyArg_UnpackTuple() argument list is not a tuple");
2713 return 0;
2714 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002715 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002716 nargs = PyTuple_GET_SIZE(args);
2717
Raymond Hettinger94230232016-03-26 03:02:48 -07002718#ifdef HAVE_STDARG_PROTOTYPES
2719 va_start(vargs, max);
2720#else
2721 va_start(vargs);
2722#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002723 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002724 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002725 return retval;
2726}
2727
2728int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002729_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002730 Py_ssize_t min, Py_ssize_t max, ...)
2731{
2732 int retval;
2733 va_list vargs;
2734
2735#ifdef HAVE_STDARG_PROTOTYPES
2736 va_start(vargs, max);
2737#else
2738 va_start(vargs);
2739#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002740 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002741 va_end(vargs);
2742 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002743}
Georg Brandl02c42872005-08-26 06:42:30 +00002744
2745
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002746#undef _PyArg_NoKeywords
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002747#undef _PyArg_NoKwnames
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002748#undef _PyArg_NoPositional
2749
Georg Brandl02c42872005-08-26 06:42:30 +00002750/* For type constructors that don't take keyword args
2751 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002752 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002753 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002754 */
2755int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002756_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002757{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002758 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002759 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002760 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002761 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002762 PyErr_BadInternalCall();
2763 return 0;
2764 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002765 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002766 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002767 }
2768
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002769 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002770 funcname);
2771 return 0;
2772}
2773
Victor Stinner29d39cc2017-01-17 01:40:01 +01002774int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002775_PyArg_NoPositional(const char *funcname, PyObject *args)
2776{
2777 if (args == NULL)
2778 return 1;
2779 if (!PyTuple_CheckExact(args)) {
2780 PyErr_BadInternalCall();
2781 return 0;
2782 }
2783 if (PyTuple_GET_SIZE(args) == 0)
2784 return 1;
2785
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002786 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002787 funcname);
2788 return 0;
2789}
2790
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002791int
2792_PyArg_NoKwnames(const char *funcname, PyObject *kwnames)
2793{
2794 if (kwnames == NULL) {
2795 return 1;
2796 }
2797
2798 assert(PyTuple_CheckExact(kwnames));
2799
2800 if (PyTuple_GET_SIZE(kwnames) == 0) {
2801 return 1;
2802 }
2803
2804 PyErr_Format(PyExc_TypeError, "%s() takes no keyword arguments", funcname);
2805 return 0;
2806}
2807
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002808void
2809_PyArg_Fini(void)
2810{
2811 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2812 while (s) {
2813 tmp = s->next;
2814 s->next = NULL;
2815 parser_clear(s);
2816 s = tmp;
2817 }
2818 static_arg_parsers = NULL;
2819}
2820
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002821#ifdef __cplusplus
2822};
2823#endif