blob: d4a531a5efb57e02729128dd2034bc4abd3394bc [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01005#include "pycore_tupleobject.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00006
Guido van Rossumc1d50531996-08-21 23:38:24 +00007#include <ctype.h>
Benjamin Petersona853a8b2017-09-07 11:13:59 -07008#include <float.h>
Guido van Rossumc1d50531996-08-21 23:38:24 +00009
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000010
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000012extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000014int PyArg_Parse(PyObject *, const char *, ...);
15int PyArg_ParseTuple(PyObject *, const char *, ...);
16int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000017
Tim Petersdbd9ba62000-07-09 03:09:57 +000018int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000020int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000021 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000022
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030023int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
24 struct _PyArg_Parser *, ...);
25int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
26 struct _PyArg_Parser *, va_list);
27
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000028#ifdef HAVE_DECLSPEC_DLL
29/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020030PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020031PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010032 const char *format, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020033PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs,
34 PyObject *kwnames,
Benjamin Peterson819a46f2016-09-09 20:45:06 -070035 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020036PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000037PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
38 const char *, char **, ...);
39PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020040PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000041PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
42 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070043
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030044PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
45 struct _PyArg_Parser *, ...);
46PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
47 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000048#endif
49
Martin v. Löwis18e16552006-02-15 17:27:45 +000050#define FLAG_COMPAT 1
51#define FLAG_SIZE_T 2
52
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040053typedef int (*destr_t)(PyObject *, void *);
54
55
56/* Keep track of "objects" that have been allocated or initialized and
57 which will need to be deallocated or cleaned up somehow if overall
58 parsing fails.
59*/
60typedef struct {
61 void *item;
62 destr_t destructor;
63} freelistentry_t;
64
65typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040066 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010067 int first_available;
68 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040069} freelist_t;
70
Antoine Pitrou7056cb22013-02-17 01:04:57 +010071#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072
73/* Forward */
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020074static int vgetargs1_impl(PyObject *args, PyObject *const *stack, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010075 const char *format, va_list *p_va, int flags);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000076static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020077static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020078static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
79 char *, size_t, freelist_t *);
80static const char *converttuple(PyObject *, const char **, va_list *, int,
81 int *, char *, size_t, int, freelist_t *);
82static const char *convertsimple(PyObject *, const char **, va_list *, int,
83 char *, size_t, freelist_t *);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +020084static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020085static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086
Tim Petersdbd9ba62000-07-09 03:09:57 +000087static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030089static int vgetargskeywordsfast(PyObject *, PyObject *,
90 struct _PyArg_Parser *, va_list *, int);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020091static int vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070092 PyObject *keywords, PyObject *kwnames,
93 struct _PyArg_Parser *parser,
94 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020095static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000096
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
105 va_end(va);
106 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000107}
108
Vinay Sajip0b60f642019-10-15 08:26:12 +0100109PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200110_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
121
Fred Drake563dfc22001-10-23 14:41:08 +0000122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 int retval;
126 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 va_start(va, format);
129 retval = vgetargs1(args, format, &va, 0);
130 va_end(va);
131 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000132}
133
Vinay Sajip0b60f642019-10-15 08:26:12 +0100134PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200135_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 int retval;
138 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 va_start(va, format);
141 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
142 va_end(va);
143 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000144}
145
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000146
147int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200148_PyArg_ParseStack(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100149{
150 int retval;
151 va_list va;
152
153 va_start(va, format);
154 retval = vgetargs1_impl(NULL, args, nargs, format, &va, 0);
155 va_end(va);
156 return retval;
157}
158
Vinay Sajip0b60f642019-10-15 08:26:12 +0100159PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200160_PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100161{
162 int retval;
163 va_list va;
164
165 va_start(va, format);
166 retval = vgetargs1_impl(NULL, args, nargs, format, &va, FLAG_SIZE_T);
167 va_end(va);
168 return retval;
169}
170
171
172int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000173PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200176 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000177
Benjamin Peterson0c212142016-09-20 20:39:33 -0700178 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000179
Christian Heimes2f2fee12016-09-21 11:37:27 +0200180 retval = vgetargs1(args, format, &lva, 0);
181 va_end(lva);
182 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000183}
184
Vinay Sajip0b60f642019-10-15 08:26:12 +0100185PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200186_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200189 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000190
Benjamin Peterson0c212142016-09-20 20:39:33 -0700191 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000192
Christian Heimes2f2fee12016-09-21 11:37:27 +0200193 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
194 va_end(lva);
195 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000196}
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000199/* Handle cleanup of allocated memory in case of exception */
200
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400201static int
202cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 if (ptr) {
205 PyMem_FREE(ptr);
206 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000208}
209
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000210static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400211cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000212{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400213 Py_buffer *buf = (Py_buffer *)ptr;
214 if (buf) {
215 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400217 return 0;
218}
219
220static int
221addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
222{
223 int index;
224
225 index = freelist->first_available;
226 freelist->first_available += 1;
227
228 freelist->entries[index].item = ptr;
229 freelist->entries[index].destructor = destructor;
230
231 return 0;
232}
233
234static int
235cleanreturn(int retval, freelist_t *freelist)
236{
237 int index;
238
239 if (retval == 0) {
240 /* A failure occurred, therefore execute all of the cleanup
241 functions.
242 */
243 for (index = 0; index < freelist->first_available; ++index) {
244 freelist->entries[index].destructor(NULL,
245 freelist->entries[index].item);
246 }
247 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100248 if (freelist->entries_malloced)
249 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000251}
252
253
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000254static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200255vgetargs1_impl(PyObject *compat_args, PyObject *const *stack, Py_ssize_t nargs, const char *format,
Victor Stinner6518a932017-01-17 01:29:49 +0100256 va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 char msgbuf[256];
259 int levels[32];
260 const char *fname = NULL;
261 const char *message = NULL;
262 int min = -1;
263 int max = 0;
264 int level = 0;
265 int endfmt = 0;
266 const char *formatsave = format;
Victor Stinner6518a932017-01-17 01:29:49 +0100267 Py_ssize_t i;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200268 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500270 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
271 freelist_t freelist;
272
Victor Stinner6518a932017-01-17 01:29:49 +0100273 assert(nargs == 0 || stack != NULL);
274
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500275 freelist.entries = static_entries;
276 freelist.first_available = 0;
277 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 while (endfmt == 0) {
282 int c = *format++;
283 switch (c) {
284 case '(':
285 if (level == 0)
286 max++;
287 level++;
288 if (level >= 30)
289 Py_FatalError("too many tuple nesting levels "
290 "in argument format string");
291 break;
292 case ')':
293 if (level == 0)
294 Py_FatalError("excess ')' in getargs format");
295 else
296 level--;
297 break;
298 case '\0':
299 endfmt = 1;
300 break;
301 case ':':
302 fname = format;
303 endfmt = 1;
304 break;
305 case ';':
306 message = format;
307 endfmt = 1;
308 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100309 case '|':
310 if (level == 0)
311 min = max;
312 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 default:
314 if (level == 0) {
Jordon Xu2ec70102019-09-11 00:04:08 +0800315 if (Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 if (c != 'e') /* skip encoded */
317 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
319 break;
320 }
321 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 if (level != 0)
324 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (min < 0)
327 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000330
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100331 if (max > STATIC_FREELIST_ENTRIES) {
332 freelist.entries = PyMem_NEW(freelistentry_t, max);
333 if (freelist.entries == NULL) {
334 PyErr_NoMemory();
335 return 0;
336 }
337 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500338 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 if (compat) {
341 if (max == 0) {
Victor Stinner6518a932017-01-17 01:29:49 +0100342 if (compat_args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100344 PyErr_Format(PyExc_TypeError,
345 "%.200s%s takes no arguments",
346 fname==NULL ? "function" : fname,
347 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400348 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 }
350 else if (min == 1 && max == 1) {
Victor Stinner6518a932017-01-17 01:29:49 +0100351 if (compat_args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100352 PyErr_Format(PyExc_TypeError,
353 "%.200s%s takes at least one argument",
354 fname==NULL ? "function" : fname,
355 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400356 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 }
Victor Stinner6518a932017-01-17 01:29:49 +0100358 msg = convertitem(compat_args, &format, p_va, flags, levels,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 msgbuf, sizeof(msgbuf), &freelist);
360 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400361 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400363 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 }
365 else {
366 PyErr_SetString(PyExc_SystemError,
367 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400368 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 }
370 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000371
Victor Stinner6518a932017-01-17 01:29:49 +0100372 if (nargs < min || max < nargs) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100373 if (message == NULL)
374 PyErr_Format(PyExc_TypeError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200375 "%.150s%s takes %s %d argument%s (%zd given)",
Victor Stinner6ced7c42011-03-21 18:15:42 +0100376 fname==NULL ? "function" : fname,
377 fname==NULL ? "" : "()",
378 min==max ? "exactly"
Victor Stinner6518a932017-01-17 01:29:49 +0100379 : nargs < min ? "at least" : "at most",
380 nargs < min ? min : max,
381 (nargs < min ? min : max) == 1 ? "" : "s",
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200382 nargs);
Victor Stinner6ced7c42011-03-21 18:15:42 +0100383 else
384 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400385 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000387
Victor Stinner6518a932017-01-17 01:29:49 +0100388 for (i = 0; i < nargs; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (*format == '|')
390 format++;
Victor Stinner6518a932017-01-17 01:29:49 +0100391 msg = convertitem(stack[i], &format, p_va,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 flags, levels, msgbuf,
393 sizeof(msgbuf), &freelist);
394 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200395 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400396 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 }
398 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000399
Jordon Xu2ec70102019-09-11 00:04:08 +0800400 if (*format != '\0' && !Py_ISALPHA(*format) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 *format != '(' &&
402 *format != '|' && *format != ':' && *format != ';') {
403 PyErr_Format(PyExc_SystemError,
404 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400405 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000407
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400408 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000409}
410
Victor Stinner6518a932017-01-17 01:29:49 +0100411static int
412vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
413{
414 PyObject **stack;
415 Py_ssize_t nargs;
416
417 if (!(flags & FLAG_COMPAT)) {
418 assert(args != NULL);
419
420 if (!PyTuple_Check(args)) {
421 PyErr_SetString(PyExc_SystemError,
422 "new style getargs format but argument is not a tuple");
423 return 0;
424 }
425
Victor Stinnerd17a6932018-11-09 16:56:48 +0100426 stack = _PyTuple_ITEMS(args);
Victor Stinner6518a932017-01-17 01:29:49 +0100427 nargs = PyTuple_GET_SIZE(args);
428 }
429 else {
430 stack = NULL;
431 nargs = 0;
432 }
433
434 return vgetargs1_impl(args, stack, nargs, format, p_va, flags);
435}
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000436
437
438static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200439seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000440 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 char buf[512];
443 int i;
444 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if (PyErr_Occurred())
447 return;
448 else if (message == NULL) {
449 if (fname != NULL) {
450 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
451 p += strlen(p);
452 }
453 if (iarg != 0) {
454 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Richard Oudkerk25296ce2013-05-18 17:35:19 +0100455 "argument %" PY_FORMAT_SIZE_T "d", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 i = 0;
457 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200458 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000459 PyOS_snprintf(p, sizeof(buf) - (p - buf),
460 ", item %d", levels[i]-1);
461 p += strlen(p);
462 i++;
463 }
464 }
465 else {
466 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
467 p += strlen(p);
468 }
469 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
470 message = buf;
471 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200472 if (msg[0] == '(') {
473 PyErr_SetString(PyExc_SystemError, message);
474 }
475 else {
476 PyErr_SetString(PyExc_TypeError, message);
477 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000478}
479
480
481/* Convert a tuple argument.
482 On entry, *p_format points to the character _after_ the opening '('.
483 On successful exit, *p_format points to the closing ')'.
484 If successful:
485 *p_format and *p_va are updated,
486 *levels and *msgbuf are untouched,
487 and NULL is returned.
488 If the argument is invalid:
489 *p_format is unchanged,
490 *p_va is undefined,
491 *levels is a 0-terminated list of item numbers,
492 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 "must be <typename1>, not <typename2>", where:
494 <typename1> is the name of the expected type, and
495 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000496 and msgbuf is returned.
497*/
498
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200499static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000500converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400502 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 int level = 0;
505 int n = 0;
506 const char *format = *p_format;
507 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100508 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 for (;;) {
511 int c = *format++;
512 if (c == '(') {
513 if (level == 0)
514 n++;
515 level++;
516 }
517 else if (c == ')') {
518 if (level == 0)
519 break;
520 level--;
521 }
522 else if (c == ':' || c == ';' || c == '\0')
523 break;
Jordon Xu2ec70102019-09-11 00:04:08 +0800524 else if (level == 0 && Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 n++;
526 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
529 levels[0] = 0;
530 PyOS_snprintf(msgbuf, bufsize,
531 toplevel ? "expected %d arguments, not %.50s" :
532 "must be %d-item sequence, not %.50s",
533 n,
Victor Stinnera102ed72020-02-07 02:24:48 +0100534 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 return msgbuf;
536 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000537
Victor Stinner74387f52013-11-18 01:21:12 +0100538 len = PySequence_Size(arg);
539 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100541 if (toplevel) {
542 PyOS_snprintf(msgbuf, bufsize,
Xtreak63262782018-12-21 20:15:13 +0530543 "expected %d argument%s, not %" PY_FORMAT_SIZE_T "d",
544 n,
545 n == 1 ? "" : "s",
546 len);
Victor Stinner74387f52013-11-18 01:21:12 +0100547 }
548 else {
549 PyOS_snprintf(msgbuf, bufsize,
550 "must be sequence of length %d, "
551 "not %" PY_FORMAT_SIZE_T "d",
552 n, len);
553 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000554 return msgbuf;
555 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000557 format = *p_format;
558 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200559 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000560 PyObject *item;
561 item = PySequence_GetItem(arg, i);
562 if (item == NULL) {
563 PyErr_Clear();
564 levels[0] = i+1;
565 levels[1] = 0;
566 strncpy(msgbuf, "is not retrievable", bufsize);
567 return msgbuf;
568 }
569 msg = convertitem(item, &format, p_va, flags, levels+1,
570 msgbuf, bufsize, freelist);
571 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
572 Py_XDECREF(item);
573 if (msg != NULL) {
574 levels[0] = i+1;
575 return msg;
576 }
577 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000579 *p_format = format;
580 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000581}
582
583
584/* Convert a single item. */
585
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200586static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000587convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400588 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000589{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200590 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000591 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000593 if (*format == '(' /* ')' */) {
594 format++;
595 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
596 bufsize, 0, freelist);
597 if (msg == NULL)
598 format++;
599 }
600 else {
601 msg = convertsimple(arg, &format, p_va, flags,
602 msgbuf, bufsize, freelist);
603 if (msg != NULL)
604 levels[0] = 0;
605 }
606 if (msg == NULL)
607 *p_format = format;
608 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000609}
610
611
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000612
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200613/* Format an error message generated by convertsimple().
614 displayname must be UTF-8 encoded.
615*/
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000616
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200617void
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200618_PyArg_BadArgument(const char *fname, const char *displayname,
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200619 const char *expected, PyObject *arg)
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200620{
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200621 PyErr_Format(PyExc_TypeError,
622 "%.200s() %.200s must be %.50s, not %.50s",
623 fname, displayname, expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100624 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200625}
626
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200627static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000628converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000629{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000630 assert(expected != NULL);
631 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200632 if (expected[0] == '(') {
633 PyOS_snprintf(msgbuf, bufsize,
634 "%.100s", expected);
635 }
636 else {
637 PyOS_snprintf(msgbuf, bufsize,
638 "must be %.50s, not %.50s", expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100639 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200640 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000641 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000642}
643
644#define CONV_UNICODE "(unicode conversion error)"
645
Guido van Rossum45aecf42006-03-15 04:58:47 +0000646/* Explicitly check for float arguments when integers are expected.
Serhiy Storchaka6a44f6e2019-02-25 17:57:58 +0200647 Return 1 for error, 0 if ok.
648 XXX Should be removed after the end of the deprecation period in
649 _PyLong_FromNbIndexOrNbInt. */
Neil Schemenauer5042da62003-02-04 20:59:40 +0000650static int
651float_argument_error(PyObject *arg)
652{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000653 if (PyFloat_Check(arg)) {
654 PyErr_SetString(PyExc_TypeError,
655 "integer argument expected, got float" );
656 return 1;
657 }
658 else
659 return 0;
Neil Schemenauer5042da62003-02-04 20:59:40 +0000660}
661
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000662/* Convert a non-tuple argument. Return NULL if conversion went OK,
663 or a string with a message describing the failure. The message is
664 formatted as "must be <desired type>, not <actual type>".
665 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000666 Don't call if a tuple is expected.
667
668 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000669*/
670
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200671static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000672convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400673 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000674{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000675 /* For # codes */
676#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
677 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
Inada Naokid3c72a22019-03-23 21:04:40 +0900678 else { \
679 if (PyErr_WarnEx(PyExc_DeprecationWarning, \
680 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) { \
681 return NULL; \
682 } \
683 q=va_arg(*p_va, int*); \
684 }
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000685#define STORE_SIZE(s) \
686 if (flags & FLAG_SIZE_T) \
687 *q2=s; \
688 else { \
689 if (INT_MAX < s) { \
690 PyErr_SetString(PyExc_OverflowError, \
691 "size does not fit in an int"); \
692 return converterr("", arg, msgbuf, bufsize); \
693 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200694 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000695 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000696#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000697#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 const char *format = *p_format;
700 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200701 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000702
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000703 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000704
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000705 case 'b': { /* unsigned byte -- very short int */
706 char *p = va_arg(*p_va, char *);
707 long ival;
708 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000709 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000710 ival = PyLong_AsLong(arg);
711 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000712 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 else if (ival < 0) {
714 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000715 "unsigned byte integer is less than minimum");
716 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000717 }
718 else if (ival > UCHAR_MAX) {
719 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000720 "unsigned byte integer is greater than maximum");
721 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 }
723 else
724 *p = (unsigned char) ival;
725 break;
726 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000727
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 case 'B': {/* byte sized bitfield - both signed and unsigned
729 values allowed */
730 char *p = va_arg(*p_va, char *);
731 long ival;
732 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000733 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000734 ival = PyLong_AsUnsignedLongMask(arg);
735 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000736 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000737 else
738 *p = (unsigned char) ival;
739 break;
740 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000741
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000742 case 'h': {/* signed short int */
743 short *p = va_arg(*p_va, short *);
744 long ival;
745 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000746 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000747 ival = PyLong_AsLong(arg);
748 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000749 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 else if (ival < SHRT_MIN) {
751 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000752 "signed short integer is less than minimum");
753 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000754 }
755 else if (ival > SHRT_MAX) {
756 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000757 "signed short integer is greater than maximum");
758 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 }
760 else
761 *p = (short) ival;
762 break;
763 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000764
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000765 case 'H': { /* short int sized bitfield, both signed and
766 unsigned allowed */
767 unsigned short *p = va_arg(*p_va, unsigned short *);
768 long ival;
769 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000770 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000771 ival = PyLong_AsUnsignedLongMask(arg);
772 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000773 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000774 else
775 *p = (unsigned short) ival;
776 break;
777 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000778
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000779 case 'i': {/* signed int */
780 int *p = va_arg(*p_va, int *);
781 long ival;
782 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000783 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 ival = PyLong_AsLong(arg);
785 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000786 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 else if (ival > INT_MAX) {
788 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000789 "signed integer is greater than maximum");
790 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 }
792 else if (ival < INT_MIN) {
793 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000794 "signed integer is less than minimum");
795 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000796 }
797 else
798 *p = ival;
799 break;
800 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000801
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000802 case 'I': { /* int sized bitfield, both signed and
803 unsigned allowed */
804 unsigned int *p = va_arg(*p_va, unsigned int *);
805 unsigned int ival;
806 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000807 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 ival = (unsigned int)PyLong_AsUnsignedLongMask(arg);
809 if (ival == (unsigned int)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000810 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000811 else
812 *p = ival;
813 break;
814 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000815
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000816 case 'n': /* Py_ssize_t */
817 {
818 PyObject *iobj;
819 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
820 Py_ssize_t ival = -1;
821 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000822 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 iobj = PyNumber_Index(arg);
824 if (iobj != NULL) {
825 ival = PyLong_AsSsize_t(iobj);
826 Py_DECREF(iobj);
827 }
828 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000829 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 *p = ival;
831 break;
832 }
833 case 'l': {/* long int */
834 long *p = va_arg(*p_va, long *);
835 long ival;
836 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000837 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 ival = PyLong_AsLong(arg);
839 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000840 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000841 else
842 *p = ival;
843 break;
844 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000845
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000846 case 'k': { /* long sized bitfield */
847 unsigned long *p = va_arg(*p_va, unsigned long *);
848 unsigned long ival;
849 if (PyLong_Check(arg))
850 ival = PyLong_AsUnsignedLongMask(arg);
851 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200852 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 *p = ival;
854 break;
855 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000856
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700857 case 'L': {/* long long */
858 long long *p = va_arg( *p_va, long long * );
859 long long ival;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000860 if (float_argument_error(arg))
Victor Stinner6ab8e822011-01-04 11:16:49 +0000861 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000862 ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700863 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000864 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000865 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000866 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000867 break;
868 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000870 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700871 unsigned long long *p = va_arg(*p_va, unsigned long long *);
872 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000873 if (PyLong_Check(arg))
874 ival = PyLong_AsUnsignedLongLongMask(arg);
875 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200876 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000877 *p = ival;
878 break;
879 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000880
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000881 case 'f': {/* float */
882 float *p = va_arg(*p_va, float *);
883 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700884 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000885 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 else
887 *p = (float) dval;
888 break;
889 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000890
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000891 case 'd': {/* double */
892 double *p = va_arg(*p_va, double *);
893 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700894 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000895 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000896 else
897 *p = dval;
898 break;
899 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000900
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 case 'D': {/* complex double */
902 Py_complex *p = va_arg(*p_va, Py_complex *);
903 Py_complex cval;
904 cval = PyComplex_AsCComplex(arg);
905 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000906 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000907 else
908 *p = cval;
909 break;
910 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000911
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000912 case 'c': {/* char */
913 char *p = va_arg(*p_va, char *);
914 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
915 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300916 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
917 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 else
919 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
920 break;
921 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000922
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000923 case 'C': {/* unicode char */
924 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200925 int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +0300926 const void *data;
Victor Stinnere1335c72011-10-04 20:53:03 +0200927
928 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000929 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200930
931 if (PyUnicode_READY(arg))
932 RETURN_ERR_OCCURRED;
933
934 if (PyUnicode_GET_LENGTH(arg) != 1)
935 return converterr("a unicode character", arg, msgbuf, bufsize);
936
937 kind = PyUnicode_KIND(arg);
938 data = PyUnicode_DATA(arg);
939 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 break;
941 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000942
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700943 case 'p': {/* boolean *p*redicate */
944 int *p = va_arg(*p_va, int *);
945 int val = PyObject_IsTrue(arg);
946 if (val > 0)
947 *p = 1;
948 else if (val == 0)
949 *p = 0;
950 else
951 RETURN_ERR_OCCURRED;
952 break;
953 }
954
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000955 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000956 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000957
Serhiy Storchakab757c832014-12-05 22:25:22 +0200958 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200960 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000961 Py_ssize_t count;
962 if (*format == '*') {
963 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
964 return converterr(buf, arg, msgbuf, bufsize);
965 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400966 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000967 return converterr(
968 "(cleanup problem)",
969 arg, msgbuf, bufsize);
970 }
971 break;
972 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200973 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 if (count < 0)
975 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000976 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 FETCH_SIZE;
978 STORE_SIZE(count);
979 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000980 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300981 if (strlen(*p) != (size_t)count) {
982 PyErr_SetString(PyExc_ValueError, "embedded null byte");
983 RETURN_ERR_OCCURRED;
984 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000985 }
986 break;
987 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000988
Serhiy Storchakab757c832014-12-05 22:25:22 +0200989 case 's': /* text string or bytes-like object */
990 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000991 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000992 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000993 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000994 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000995
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000996 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000997 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
998 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200999 Py_ssize_t len;
1000 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1001 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001002 return converterr(CONV_UNICODE,
1003 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001004 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001005 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001006 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001007 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001008 if (getbuffer(arg, p, &buf) < 0)
1009 return converterr(buf, arg, msgbuf, bufsize);
1010 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001011 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 return converterr(
1013 "(cleanup problem)",
1014 arg, msgbuf, bufsize);
1015 }
1016 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +02001017 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001018 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001019 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001020 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001021
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001022 if (c == 'z' && arg == Py_None) {
1023 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001024 STORE_SIZE(0);
1025 }
1026 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001027 Py_ssize_t len;
1028 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1029 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 return converterr(CONV_UNICODE,
1031 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001032 *p = sarg;
1033 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001034 }
Serhiy Storchakab757c832014-12-05 22:25:22 +02001035 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001036 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001037 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001038 Py_ssize_t count = convertbuffer(arg, p, &buf);
1039 if (count < 0)
1040 return converterr(buf, arg, msgbuf, bufsize);
1041 STORE_SIZE(count);
1042 }
1043 format++;
1044 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001045 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001046 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001047 Py_ssize_t len;
1048 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001049
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001050 if (c == 'z' && arg == Py_None)
1051 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001052 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001053 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1054 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001055 return converterr(CONV_UNICODE,
1056 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001057 if (strlen(sarg) != (size_t)len) {
1058 PyErr_SetString(PyExc_ValueError, "embedded null character");
1059 RETURN_ERR_OCCURRED;
1060 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001061 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001062 }
1063 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001064 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001065 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001066 }
1067 break;
1068 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001069
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001070 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1071 case 'Z': /* raw unicode buffer or None */
1072 {
Inada Naoki610a60c2020-06-18 17:30:53 +09001073 // TODO: Raise DeprecationWarning
1074_Py_COMP_DIAG_PUSH
1075_Py_COMP_DIAG_IGNORE_DEPR_DECLS
Brett Cannonb94767f2011-02-22 20:15:44 +00001076 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1077
Serhiy Storchakab757c832014-12-05 22:25:22 +02001078 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001079 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001080 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001081
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001082 if (c == 'Z' && arg == Py_None) {
1083 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001084 STORE_SIZE(0);
1085 }
1086 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001087 Py_ssize_t len;
1088 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001089 if (*p == NULL)
1090 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001091 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001092 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001093 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001094 return converterr(c == 'Z' ? "str or None" : "str",
1095 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001096 format++;
1097 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001098 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001099 if (c == 'Z' && arg == Py_None)
1100 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001101 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001102 Py_ssize_t len;
1103 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001104 if (*p == NULL)
1105 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001106 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001107 PyErr_SetString(PyExc_ValueError, "embedded null character");
1108 RETURN_ERR_OCCURRED;
1109 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001110 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001111 return converterr(c == 'Z' ? "str or None" : "str",
1112 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 }
1114 break;
Inada Naoki610a60c2020-06-18 17:30:53 +09001115_Py_COMP_DIAG_POP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001116 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001118 case 'e': {/* encoded string */
1119 char **buffer;
1120 const char *encoding;
1121 PyObject *s;
1122 int recode_strings;
1123 Py_ssize_t size;
1124 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001125
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001126 /* Get 'e' parameter: the encoding name */
1127 encoding = (const char *)va_arg(*p_va, const char *);
1128 if (encoding == NULL)
1129 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001130
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001131 /* Get output buffer parameter:
1132 's' (recode all objects via Unicode) or
1133 't' (only recode non-string objects)
1134 */
1135 if (*format == 's')
1136 recode_strings = 1;
1137 else if (*format == 't')
1138 recode_strings = 0;
1139 else
1140 return converterr(
1141 "(unknown parser marker combination)",
1142 arg, msgbuf, bufsize);
1143 buffer = (char **)va_arg(*p_va, char **);
1144 format++;
1145 if (buffer == NULL)
1146 return converterr("(buffer is NULL)",
1147 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001148
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 /* Encode object */
1150 if (!recode_strings &&
1151 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1152 s = arg;
1153 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001154 if (PyBytes_Check(arg)) {
1155 size = PyBytes_GET_SIZE(s);
1156 ptr = PyBytes_AS_STRING(s);
1157 }
1158 else {
1159 size = PyByteArray_GET_SIZE(s);
1160 ptr = PyByteArray_AS_STRING(s);
1161 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001162 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001163 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001164 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001165 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001166 encoding,
1167 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 if (s == NULL)
1169 return converterr("(encoding failed)",
1170 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001171 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001172 size = PyBytes_GET_SIZE(s);
1173 ptr = PyBytes_AS_STRING(s);
1174 if (ptr == NULL)
1175 ptr = "";
1176 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001177 else {
1178 return converterr(
1179 recode_strings ? "str" : "str, bytes or bytearray",
1180 arg, msgbuf, bufsize);
1181 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001182
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001183 /* Write output; output is guaranteed to be 0-terminated */
1184 if (*format == '#') {
1185 /* Using buffer length parameter '#':
1186
1187 - if *buffer is NULL, a new buffer of the
1188 needed size is allocated and the data
1189 copied into it; *buffer is updated to point
1190 to the new buffer; the caller is
1191 responsible for PyMem_Free()ing it after
1192 usage
1193
1194 - if *buffer is not NULL, the data is
1195 copied to *buffer; *buffer_len has to be
1196 set to the size of the buffer on input;
1197 buffer overflow is signalled with an error;
1198 buffer has to provide enough room for the
1199 encoded string plus the trailing 0-byte
1200
1201 - in both cases, *buffer_len is updated to
1202 the size of the buffer /excluding/ the
1203 trailing 0-byte
1204
1205 */
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001206 int *q = NULL; Py_ssize_t *q2 = NULL;
1207 if (flags & FLAG_SIZE_T) {
1208 q2 = va_arg(*p_va, Py_ssize_t*);
1209 }
1210 else {
1211 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1212 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1))
1213 {
1214 Py_DECREF(s);
1215 return NULL;
1216 }
1217 q = va_arg(*p_va, int*);
1218 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001219
1220 format++;
1221 if (q == NULL && q2 == NULL) {
1222 Py_DECREF(s);
1223 return converterr(
1224 "(buffer_len is NULL)",
1225 arg, msgbuf, bufsize);
1226 }
1227 if (*buffer == NULL) {
1228 *buffer = PyMem_NEW(char, size + 1);
1229 if (*buffer == NULL) {
1230 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001231 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001232 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001234 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001235 Py_DECREF(s);
1236 return converterr(
1237 "(cleanup problem)",
1238 arg, msgbuf, bufsize);
1239 }
1240 } else {
1241 if (size + 1 > BUFFER_LEN) {
1242 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001243 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001244 "encoded string too long "
1245 "(%zd, maximum length %zd)",
1246 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1247 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 }
1249 }
1250 memcpy(*buffer, ptr, size+1);
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001251
1252 if (flags & FLAG_SIZE_T) {
1253 *q2 = size;
1254 }
1255 else {
1256 if (INT_MAX < size) {
1257 Py_DECREF(s);
1258 PyErr_SetString(PyExc_OverflowError,
1259 "size does not fit in an int");
1260 return converterr("", arg, msgbuf, bufsize);
1261 }
1262 *q = (int)size;
1263 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001264 } else {
1265 /* Using a 0-terminated buffer:
1266
1267 - the encoded string has to be 0-terminated
1268 for this variant to work; if it is not, an
1269 error raised
1270
1271 - a new buffer of the needed size is
1272 allocated and the data copied into it;
1273 *buffer is updated to point to the new
1274 buffer; the caller is responsible for
1275 PyMem_Free()ing it after usage
1276
1277 */
1278 if ((Py_ssize_t)strlen(ptr) != size) {
1279 Py_DECREF(s);
1280 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001281 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001282 arg, msgbuf, bufsize);
1283 }
1284 *buffer = PyMem_NEW(char, size + 1);
1285 if (*buffer == NULL) {
1286 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001287 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001288 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001290 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 Py_DECREF(s);
1292 return converterr("(cleanup problem)",
1293 arg, msgbuf, bufsize);
1294 }
1295 memcpy(*buffer, ptr, size+1);
1296 }
1297 Py_DECREF(s);
1298 break;
1299 }
1300
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 case 'S': { /* PyBytes object */
1302 PyObject **p = va_arg(*p_va, PyObject **);
1303 if (PyBytes_Check(arg))
1304 *p = arg;
1305 else
1306 return converterr("bytes", arg, msgbuf, bufsize);
1307 break;
1308 }
1309
1310 case 'Y': { /* PyByteArray object */
1311 PyObject **p = va_arg(*p_va, PyObject **);
1312 if (PyByteArray_Check(arg))
1313 *p = arg;
1314 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001315 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 break;
1317 }
1318
1319 case 'U': { /* PyUnicode object */
1320 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001321 if (PyUnicode_Check(arg)) {
1322 if (PyUnicode_READY(arg) == -1)
1323 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001325 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001326 else
1327 return converterr("str", arg, msgbuf, bufsize);
1328 break;
1329 }
1330
1331 case 'O': { /* object */
1332 PyTypeObject *type;
1333 PyObject **p;
1334 if (*format == '!') {
1335 type = va_arg(*p_va, PyTypeObject*);
1336 p = va_arg(*p_va, PyObject **);
1337 format++;
Victor Stinnera102ed72020-02-07 02:24:48 +01001338 if (PyType_IsSubtype(Py_TYPE(arg), type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001339 *p = arg;
1340 else
1341 return converterr(type->tp_name, arg, msgbuf, bufsize);
1342
1343 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001344 else if (*format == '&') {
1345 typedef int (*converter)(PyObject *, void *);
1346 converter convert = va_arg(*p_va, converter);
1347 void *addr = va_arg(*p_va, void *);
1348 int res;
1349 format++;
1350 if (! (res = (*convert)(arg, addr)))
1351 return converterr("(unspecified)",
1352 arg, msgbuf, bufsize);
1353 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001354 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001355 return converterr("(cleanup problem)",
1356 arg, msgbuf, bufsize);
1357 }
1358 else {
1359 p = va_arg(*p_va, PyObject **);
1360 *p = arg;
1361 }
1362 break;
1363 }
1364
1365
Victor Stinner25e8ec42010-06-25 00:02:38 +00001366 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001367 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001368
Victor Stinner25e8ec42010-06-25 00:02:38 +00001369 if (*format != '*')
1370 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001371 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001372 arg, msgbuf, bufsize);
1373 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001374
Victor Stinner25e8ec42010-06-25 00:02:38 +00001375 /* Caller is interested in Py_buffer, and the object
1376 supports it directly. */
1377 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1378 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001379 return converterr("read-write bytes-like object",
1380 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 }
Victor Stinner8182b712010-07-28 00:40:58 +00001382 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1383 PyBuffer_Release((Py_buffer*)p);
1384 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1385 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001386 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001387 return converterr(
1388 "(cleanup problem)",
1389 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001390 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001391 break;
1392 }
1393
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001394 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001395 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001396
1397 }
1398
1399 *p_format = format;
1400 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001401
1402#undef FETCH_SIZE
1403#undef STORE_SIZE
1404#undef BUFFER_LEN
1405#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001406}
Guido van Rossumaa354651996-08-19 19:32:04 +00001407
Martin v. Löwis18e16552006-02-15 17:27:45 +00001408static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001409convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001410{
Victor Stinner5cb62392010-06-06 20:27:51 +00001411 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 Py_ssize_t count;
1413 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 *errmsg = NULL;
1416 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001417 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001418 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001419 return -1;
1420 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001421
Victor Stinner8182b712010-07-28 00:40:58 +00001422 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001423 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 count = view.len;
1425 *p = view.buf;
1426 PyBuffer_Release(&view);
1427 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001428}
Guido van Rossumaa354651996-08-19 19:32:04 +00001429
Martin v. Löwis423be952008-08-13 15:53:07 +00001430static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001431getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001432{
Victor Stinner8182b712010-07-28 00:40:58 +00001433 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001434 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001435 return -1;
1436 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001437 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001438 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001439 *errmsg = "contiguous buffer";
1440 return -1;
1441 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001442 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001443}
1444
Guido van Rossumaa354651996-08-19 19:32:04 +00001445/* Support for keyword arguments donated by
1446 Geoff Philbrick <philbric@delphi.hks.com> */
1447
Tim Petersf8cd3e82001-10-27 04:26:57 +00001448/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001449int
1450PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 PyObject *keywords,
1452 const char *format,
1453 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001454{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 int retval;
1456 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001457
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001458 if ((args == NULL || !PyTuple_Check(args)) ||
1459 (keywords != NULL && !PyDict_Check(keywords)) ||
1460 format == NULL ||
1461 kwlist == NULL)
1462 {
1463 PyErr_BadInternalCall();
1464 return 0;
1465 }
Tim Peters45772cd2001-10-27 03:58:40 +00001466
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001467 va_start(va, kwlist);
1468 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1469 va_end(va);
1470 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001471}
1472
Vinay Sajip0b60f642019-10-15 08:26:12 +01001473PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001474_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001475 PyObject *keywords,
1476 const char *format,
1477 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001478{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 int retval;
1480 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001481
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001482 if ((args == NULL || !PyTuple_Check(args)) ||
1483 (keywords != NULL && !PyDict_Check(keywords)) ||
1484 format == NULL ||
1485 kwlist == NULL)
1486 {
1487 PyErr_BadInternalCall();
1488 return 0;
1489 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001490
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001491 va_start(va, kwlist);
1492 retval = vgetargskeywords(args, keywords, format,
1493 kwlist, &va, FLAG_SIZE_T);
1494 va_end(va);
1495 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001496}
1497
1498
Brett Cannon711e7d92004-07-10 22:20:32 +00001499int
1500PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001501 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001502 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001503 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001504{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 int retval;
1506 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001508 if ((args == NULL || !PyTuple_Check(args)) ||
1509 (keywords != NULL && !PyDict_Check(keywords)) ||
1510 format == NULL ||
1511 kwlist == NULL)
1512 {
1513 PyErr_BadInternalCall();
1514 return 0;
1515 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001516
Benjamin Peterson0c212142016-09-20 20:39:33 -07001517 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001518
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001520 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001521 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001522}
1523
Vinay Sajip0b60f642019-10-15 08:26:12 +01001524PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001525_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001526 PyObject *keywords,
1527 const char *format,
1528 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001530 int retval;
1531 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001532
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 if ((args == NULL || !PyTuple_Check(args)) ||
1534 (keywords != NULL && !PyDict_Check(keywords)) ||
1535 format == NULL ||
1536 kwlist == NULL)
1537 {
1538 PyErr_BadInternalCall();
1539 return 0;
1540 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001541
Benjamin Peterson0c212142016-09-20 20:39:33 -07001542 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001543
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001544 retval = vgetargskeywords(args, keywords, format,
1545 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001546 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001548}
1549
Vinay Sajip0b60f642019-10-15 08:26:12 +01001550PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001551_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1552 struct _PyArg_Parser *parser, ...)
1553{
1554 int retval;
1555 va_list va;
1556
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001557 va_start(va, parser);
1558 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1559 va_end(va);
1560 return retval;
1561}
1562
Vinay Sajip0b60f642019-10-15 08:26:12 +01001563PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001564_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1565 struct _PyArg_Parser *parser, ...)
1566{
1567 int retval;
1568 va_list va;
1569
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001570 va_start(va, parser);
1571 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1572 va_end(va);
1573 return retval;
1574}
1575
Vinay Sajip0b60f642019-10-15 08:26:12 +01001576PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001577_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001578 struct _PyArg_Parser *parser, ...)
1579{
1580 int retval;
1581 va_list va;
1582
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001583 va_start(va, parser);
1584 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1585 va_end(va);
1586 return retval;
1587}
1588
Vinay Sajip0b60f642019-10-15 08:26:12 +01001589PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001590_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001591 struct _PyArg_Parser *parser, ...)
1592{
1593 int retval;
1594 va_list va;
1595
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001596 va_start(va, parser);
1597 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1598 va_end(va);
1599 return retval;
1600}
1601
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001602
Vinay Sajip0b60f642019-10-15 08:26:12 +01001603PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001604_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1605 struct _PyArg_Parser *parser, va_list va)
1606{
1607 int retval;
1608 va_list lva;
1609
Benjamin Peterson0c212142016-09-20 20:39:33 -07001610 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001611
1612 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001613 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001614 return retval;
1615}
1616
Vinay Sajip0b60f642019-10-15 08:26:12 +01001617PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001618_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1619 struct _PyArg_Parser *parser, va_list va)
1620{
1621 int retval;
1622 va_list lva;
1623
Benjamin Peterson0c212142016-09-20 20:39:33 -07001624 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001625
1626 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001627 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001628 return retval;
1629}
1630
1631int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001632PyArg_ValidateKeywordArguments(PyObject *kwargs)
1633{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001634 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001635 PyErr_BadInternalCall();
1636 return 0;
1637 }
1638 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1639 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001640 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001641 return 0;
1642 }
1643 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001644}
1645
Christian Heimes380f7f22008-02-28 11:19:05 +00001646#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001647
Guido van Rossumaa354651996-08-19 19:32:04 +00001648static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001649vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001651{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001652 char msgbuf[512];
1653 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001654 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001656 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001657 int i, pos, len;
1658 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001659 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001660 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001661 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001662 freelist_t freelist;
1663
1664 freelist.entries = static_entries;
1665 freelist.first_available = 0;
1666 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001667
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001668 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001669 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001670 assert(format != NULL);
1671 assert(kwlist != NULL);
1672 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001674 /* grab the function name or custom error msg first (mutually exclusive) */
1675 fname = strchr(format, ':');
1676 if (fname) {
1677 fname++;
1678 custom_msg = NULL;
1679 }
1680 else {
1681 custom_msg = strchr(format,';');
1682 if (custom_msg)
1683 custom_msg++;
1684 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001685
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001686 /* scan kwlist and count the number of positional-only parameters */
1687 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1688 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001690 for (len = pos; kwlist[len]; len++) {
1691 if (!*kwlist[len]) {
1692 PyErr_SetString(PyExc_SystemError,
1693 "Empty keyword parameter name");
1694 return cleanreturn(0, &freelist);
1695 }
1696 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001697
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001698 if (len > STATIC_FREELIST_ENTRIES) {
1699 freelist.entries = PyMem_NEW(freelistentry_t, len);
1700 if (freelist.entries == NULL) {
1701 PyErr_NoMemory();
1702 return 0;
1703 }
1704 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001705 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001706
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001708 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1709 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001710 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1711 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001712 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001713 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001714 (fname == NULL) ? "function" : fname,
1715 (fname == NULL) ? "" : "()",
1716 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001717 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001718 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001719 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001720 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 }
Tim Petersc2f01122001-10-27 07:25:06 +00001722
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001723 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1724 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001726 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001727 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001728 "Invalid format string (| specified twice)");
1729 return cleanreturn(0, &freelist);
1730 }
1731
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001732 min = i;
1733 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001734
1735 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001736 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001737 "Invalid format string ($ before |)");
1738 return cleanreturn(0, &freelist);
1739 }
1740 }
1741 if (*format == '$') {
1742 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001743 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001744 "Invalid format string ($ specified twice)");
1745 return cleanreturn(0, &freelist);
1746 }
1747
1748 max = i;
1749 format++;
1750
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001751 if (max < pos) {
1752 PyErr_SetString(PyExc_SystemError,
1753 "Empty parameter name after $");
1754 return cleanreturn(0, &freelist);
1755 }
1756 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001757 /* Now we know the minimal and the maximal numbers of
1758 * positional arguments and can raise an exception with
1759 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001760 break;
1761 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001762 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001763 if (max == 0) {
1764 PyErr_Format(PyExc_TypeError,
1765 "%.200s%s takes no positional arguments",
1766 (fname == NULL) ? "function" : fname,
1767 (fname == NULL) ? "" : "()");
1768 }
1769 else {
1770 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301771 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001772 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001773 (fname == NULL) ? "function" : fname,
1774 (fname == NULL) ? "" : "()",
1775 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301776 max,
1777 max == 1 ? "" : "s",
1778 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001779 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001780 return cleanreturn(0, &freelist);
1781 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001782 }
1783 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001784 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 "More keyword list entries (%d) than "
1786 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001787 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001789 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001790 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001791 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001792 }
1793 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001794 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1795 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001796 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001797 }
1798 else if (PyErr_Occurred()) {
1799 return cleanreturn(0, &freelist);
1800 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001801 }
1802 else {
1803 current_arg = NULL;
1804 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001805
1806 if (current_arg) {
1807 msg = convertitem(current_arg, &format, p_va, flags,
1808 levels, msgbuf, sizeof(msgbuf), &freelist);
1809 if (msg) {
1810 seterror(i+1, msg, levels, fname, custom_msg);
1811 return cleanreturn(0, &freelist);
1812 }
1813 continue;
1814 }
1815
1816 if (i < min) {
1817 if (i < pos) {
1818 assert (min == INT_MAX);
1819 assert (max == INT_MAX);
1820 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001821 /* At that moment we still don't know the minimal and
1822 * the maximal numbers of positional arguments. Raising
1823 * an exception is deferred until we encounter | and $
1824 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001825 }
1826 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001827 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1828 "argument '%s' (pos %d)",
1829 (fname == NULL) ? "function" : fname,
1830 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001831 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001832 return cleanreturn(0, &freelist);
1833 }
1834 }
1835 /* current code reports success when all required args
1836 * fulfilled and no keyword args left, with no further
1837 * validation. XXX Maybe skip this in debug build ?
1838 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001839 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001840 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001841 }
1842 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001843
Leo Ariasc3d95082018-02-03 18:36:10 -06001844 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001845 * keyword args */
1846 msg = skipitem(&format, p_va, flags);
1847 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001848 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001849 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001850 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001851 }
1852 }
Tim Petersb054be42001-10-27 05:07:41 +00001853
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001854 if (skip) {
1855 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301856 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001857 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001858 (fname == NULL) ? "function" : fname,
1859 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001860 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301861 Py_MIN(pos, min),
1862 Py_MIN(pos, min) == 1 ? "" : "s",
1863 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001864 return cleanreturn(0, &freelist);
1865 }
1866
Larry Hastings83a9f482012-03-20 20:06:16 +00001867 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001868 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001869 "more argument specifiers than keyword list entries "
1870 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001871 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001872 }
Tim Petersc2f01122001-10-27 07:25:06 +00001873
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001874 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001875 PyObject *key;
1876 Py_ssize_t j;
1877 /* make sure there are no arguments given by name and position */
1878 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001879 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001880 if (current_arg) {
1881 /* arg present in tuple and in dict */
1882 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001883 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001884 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001885 (fname == NULL) ? "function" : fname,
1886 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001887 kwlist[i], i+1);
1888 return cleanreturn(0, &freelist);
1889 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001890 else if (PyErr_Occurred()) {
1891 return cleanreturn(0, &freelist);
1892 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001893 }
1894 /* make sure there are no extraneous keyword arguments */
1895 j = 0;
1896 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001897 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001898 if (!PyUnicode_Check(key)) {
1899 PyErr_SetString(PyExc_TypeError,
1900 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001901 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001902 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001903 for (i = pos; i < len; i++) {
1904 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001905 match = 1;
1906 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001907 }
1908 }
1909 if (!match) {
1910 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001911 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001912 "argument for %.200s%s",
1913 key,
1914 (fname == NULL) ? "this function" : fname,
1915 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001916 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001917 }
1918 }
1919 }
1920
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001921 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001922}
1923
1924
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001925/* List of static parsers. */
1926static struct _PyArg_Parser *static_arg_parsers = NULL;
1927
1928static int
1929parser_init(struct _PyArg_Parser *parser)
1930{
1931 const char * const *keywords;
1932 const char *format, *msg;
1933 int i, len, min, max, nkw;
1934 PyObject *kwtuple;
1935
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001936 assert(parser->keywords != NULL);
1937 if (parser->kwtuple != NULL) {
1938 return 1;
1939 }
1940
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001941 keywords = parser->keywords;
1942 /* scan keywords and count the number of positional-only parameters */
1943 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1944 }
1945 parser->pos = i;
1946 /* scan keywords and get greatest possible nbr of args */
1947 for (; keywords[i]; i++) {
1948 if (!*keywords[i]) {
1949 PyErr_SetString(PyExc_SystemError,
1950 "Empty keyword parameter name");
1951 return 0;
1952 }
1953 }
1954 len = i;
1955
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001956 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001957 if (format) {
1958 /* grab the function name or custom error msg first (mutually exclusive) */
1959 parser->fname = strchr(parser->format, ':');
1960 if (parser->fname) {
1961 parser->fname++;
1962 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001963 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001964 else {
1965 parser->custom_msg = strchr(parser->format,';');
1966 if (parser->custom_msg)
1967 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001968 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001969
1970 min = max = INT_MAX;
1971 for (i = 0; i < len; i++) {
1972 if (*format == '|') {
1973 if (min != INT_MAX) {
1974 PyErr_SetString(PyExc_SystemError,
1975 "Invalid format string (| specified twice)");
1976 return 0;
1977 }
1978 if (max != INT_MAX) {
1979 PyErr_SetString(PyExc_SystemError,
1980 "Invalid format string ($ before |)");
1981 return 0;
1982 }
1983 min = i;
1984 format++;
1985 }
1986 if (*format == '$') {
1987 if (max != INT_MAX) {
1988 PyErr_SetString(PyExc_SystemError,
1989 "Invalid format string ($ specified twice)");
1990 return 0;
1991 }
1992 if (i < parser->pos) {
1993 PyErr_SetString(PyExc_SystemError,
1994 "Empty parameter name after $");
1995 return 0;
1996 }
1997 max = i;
1998 format++;
1999 }
2000 if (IS_END_OF_FORMAT(*format)) {
2001 PyErr_Format(PyExc_SystemError,
2002 "More keyword list entries (%d) than "
2003 "format specifiers (%d)", len, i);
2004 return 0;
2005 }
2006
2007 msg = skipitem(&format, NULL, 0);
2008 if (msg) {
2009 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
2010 format);
2011 return 0;
2012 }
2013 }
2014 parser->min = Py_MIN(min, len);
2015 parser->max = Py_MIN(max, len);
2016
2017 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002018 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02002019 "more argument specifiers than keyword list entries "
2020 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002021 return 0;
2022 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002023 }
2024
2025 nkw = len - parser->pos;
2026 kwtuple = PyTuple_New(nkw);
2027 if (kwtuple == NULL) {
2028 return 0;
2029 }
2030 keywords = parser->keywords + parser->pos;
2031 for (i = 0; i < nkw; i++) {
2032 PyObject *str = PyUnicode_FromString(keywords[i]);
2033 if (str == NULL) {
2034 Py_DECREF(kwtuple);
2035 return 0;
2036 }
2037 PyUnicode_InternInPlace(&str);
2038 PyTuple_SET_ITEM(kwtuple, i, str);
2039 }
2040 parser->kwtuple = kwtuple;
2041
2042 assert(parser->next == NULL);
2043 parser->next = static_arg_parsers;
2044 static_arg_parsers = parser;
2045 return 1;
2046}
2047
2048static void
2049parser_clear(struct _PyArg_Parser *parser)
2050{
2051 Py_CLEAR(parser->kwtuple);
2052}
2053
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002054static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002055find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002056{
2057 Py_ssize_t i, nkwargs;
2058
2059 nkwargs = PyTuple_GET_SIZE(kwnames);
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002060 for (i = 0; i < nkwargs; i++) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002061 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2062
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002063 /* kwname == key will normally find a match in since keyword keys
2064 should be interned strings; if not retry below in a new loop. */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002065 if (kwname == key) {
2066 return kwstack[i];
2067 }
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002068 }
2069
2070 for (i = 0; i < nkwargs; i++) {
2071 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
Jeroen Demeyer05677862019-08-16 12:41:27 +02002072 assert(PyUnicode_Check(kwname));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002073 if (_PyUnicode_EQ(kwname, key)) {
2074 return kwstack[i];
2075 }
2076 }
2077 return NULL;
2078}
2079
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002080static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002081vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002082 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002083 struct _PyArg_Parser *parser,
2084 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002085{
2086 PyObject *kwtuple;
2087 char msgbuf[512];
2088 int levels[32];
2089 const char *format;
2090 const char *msg;
2091 PyObject *keyword;
2092 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002093 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002094 PyObject *current_arg;
2095 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2096 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002097 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002098
2099 freelist.entries = static_entries;
2100 freelist.first_available = 0;
2101 freelist.entries_malloced = 0;
2102
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002103 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002104 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002105 assert(p_va != NULL);
2106
Victor Stinner80ab22f2017-01-16 23:16:47 +01002107 if (parser == NULL) {
2108 PyErr_BadInternalCall();
2109 return 0;
2110 }
2111
2112 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2113 PyErr_BadInternalCall();
2114 return 0;
2115 }
2116
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002117 if (!parser_init(parser)) {
2118 return 0;
2119 }
2120
2121 kwtuple = parser->kwtuple;
2122 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002123 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002124
2125 if (len > STATIC_FREELIST_ENTRIES) {
2126 freelist.entries = PyMem_NEW(freelistentry_t, len);
2127 if (freelist.entries == NULL) {
2128 PyErr_NoMemory();
2129 return 0;
2130 }
2131 freelist.entries_malloced = 1;
2132 }
2133
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002134 if (kwargs != NULL) {
2135 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002136 }
2137 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002138 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002139 kwstack = args + nargs;
2140 }
2141 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002142 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002143 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002144 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002145 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2146 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002147 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002148 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002149 (parser->fname == NULL) ? "function" : parser->fname,
2150 (parser->fname == NULL) ? "" : "()",
2151 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002152 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002153 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002154 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002155 return cleanreturn(0, &freelist);
2156 }
2157 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002158 if (parser->max == 0) {
2159 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002160 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002161 (parser->fname == NULL) ? "function" : parser->fname,
2162 (parser->fname == NULL) ? "" : "()");
2163 }
2164 else {
2165 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002166 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002167 (parser->fname == NULL) ? "function" : parser->fname,
2168 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002169 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302170 parser->max,
2171 parser->max == 1 ? "" : "s",
2172 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002173 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002174 return cleanreturn(0, &freelist);
2175 }
2176
2177 format = parser->format;
2178 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2179 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002180 if (*format == '|') {
2181 format++;
2182 }
2183 if (*format == '$') {
2184 format++;
2185 }
2186 assert(!IS_END_OF_FORMAT(*format));
2187
Serhiy Storchaka17414412017-01-17 10:07:25 +02002188 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002189 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002190 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002191 else if (nkwargs && i >= pos) {
2192 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002193 if (kwargs != NULL) {
2194 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2195 if (!current_arg && PyErr_Occurred()) {
2196 return cleanreturn(0, &freelist);
2197 }
2198 }
2199 else {
2200 current_arg = find_keyword(kwnames, kwstack, keyword);
2201 }
2202 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002203 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002204 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002205 }
2206 else {
2207 current_arg = NULL;
2208 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002209
2210 if (current_arg) {
2211 msg = convertitem(current_arg, &format, p_va, flags,
2212 levels, msgbuf, sizeof(msgbuf), &freelist);
2213 if (msg) {
2214 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2215 return cleanreturn(0, &freelist);
2216 }
2217 continue;
2218 }
2219
2220 if (i < parser->min) {
2221 /* Less arguments than required */
2222 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002223 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002224 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302225 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002226 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002227 (parser->fname == NULL) ? "function" : parser->fname,
2228 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002229 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302230 min,
2231 min == 1 ? "" : "s",
2232 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002233 }
2234 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002235 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002236 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2237 "argument '%U' (pos %d)",
2238 (parser->fname == NULL) ? "function" : parser->fname,
2239 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002240 keyword, i+1);
2241 }
2242 return cleanreturn(0, &freelist);
2243 }
2244 /* current code reports success when all required args
2245 * fulfilled and no keyword args left, with no further
2246 * validation. XXX Maybe skip this in debug build ?
2247 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002248 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002249 return cleanreturn(1, &freelist);
2250 }
2251
Leo Ariasc3d95082018-02-03 18:36:10 -06002252 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002253 * keyword args */
2254 msg = skipitem(&format, p_va, flags);
2255 assert(msg == NULL);
2256 }
2257
2258 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2259
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002260 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002261 Py_ssize_t j;
2262 /* make sure there are no arguments given by name and position */
2263 for (i = pos; i < nargs; i++) {
2264 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002265 if (kwargs != NULL) {
2266 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2267 if (!current_arg && PyErr_Occurred()) {
2268 return cleanreturn(0, &freelist);
2269 }
2270 }
2271 else {
2272 current_arg = find_keyword(kwnames, kwstack, keyword);
2273 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002274 if (current_arg) {
2275 /* arg present in tuple and in dict */
2276 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002277 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002278 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002279 (parser->fname == NULL) ? "function" : parser->fname,
2280 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002281 keyword, i+1);
2282 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002283 }
2284 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002285 /* make sure there are no extraneous keyword arguments */
2286 j = 0;
2287 while (1) {
2288 int match;
2289 if (kwargs != NULL) {
2290 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2291 break;
2292 }
2293 else {
2294 if (j >= PyTuple_GET_SIZE(kwnames))
2295 break;
2296 keyword = PyTuple_GET_ITEM(kwnames, j);
2297 j++;
2298 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002299
Serhiy Storchaka17414412017-01-17 10:07:25 +02002300 match = PySequence_Contains(kwtuple, keyword);
2301 if (match <= 0) {
2302 if (!match) {
2303 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002304 "'%S' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002305 "argument for %.200s%s",
2306 keyword,
2307 (parser->fname == NULL) ? "this function" : parser->fname,
2308 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002309 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002310 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002311 }
2312 }
2313 }
2314
2315 return cleanreturn(1, &freelist);
2316}
2317
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002318static int
2319vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2320 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2321{
2322 PyObject **stack;
2323 Py_ssize_t nargs;
2324
Victor Stinner80ab22f2017-01-16 23:16:47 +01002325 if (args == NULL
2326 || !PyTuple_Check(args)
2327 || (keywords != NULL && !PyDict_Check(keywords)))
2328 {
2329 PyErr_BadInternalCall();
2330 return 0;
2331 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002332
Victor Stinnerd17a6932018-11-09 16:56:48 +01002333 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002334 nargs = PyTuple_GET_SIZE(args);
2335 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2336 parser, p_va, flags);
2337}
2338
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002339
Serhiy Storchaka31913912019-03-14 10:32:22 +02002340#undef _PyArg_UnpackKeywords
2341
2342PyObject * const *
2343_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2344 PyObject *kwargs, PyObject *kwnames,
2345 struct _PyArg_Parser *parser,
2346 int minpos, int maxpos, int minkw,
2347 PyObject **buf)
2348{
2349 PyObject *kwtuple;
2350 PyObject *keyword;
2351 int i, posonly, minposonly, maxargs;
2352 int reqlimit = minkw ? maxpos + minkw : minpos;
2353 Py_ssize_t nkwargs;
2354 PyObject *current_arg;
2355 PyObject * const *kwstack = NULL;
2356
2357 assert(kwargs == NULL || PyDict_Check(kwargs));
2358 assert(kwargs == NULL || kwnames == NULL);
2359
2360 if (parser == NULL) {
2361 PyErr_BadInternalCall();
2362 return NULL;
2363 }
2364
2365 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2366 PyErr_BadInternalCall();
2367 return NULL;
2368 }
2369
2370 if (args == NULL && nargs == 0) {
2371 args = buf;
2372 }
2373
2374 if (!parser_init(parser)) {
2375 return NULL;
2376 }
2377
2378 kwtuple = parser->kwtuple;
2379 posonly = parser->pos;
2380 minposonly = Py_MIN(posonly, minpos);
2381 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2382
2383 if (kwargs != NULL) {
2384 nkwargs = PyDict_GET_SIZE(kwargs);
2385 }
2386 else if (kwnames != NULL) {
2387 nkwargs = PyTuple_GET_SIZE(kwnames);
2388 kwstack = args + nargs;
2389 }
2390 else {
2391 nkwargs = 0;
2392 }
2393 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2394 /* Fast path. */
2395 return args;
2396 }
2397 if (nargs + nkwargs > maxargs) {
2398 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2399 messages in some special cases (see bpo-31229). */
2400 PyErr_Format(PyExc_TypeError,
2401 "%.200s%s takes at most %d %sargument%s (%zd given)",
2402 (parser->fname == NULL) ? "function" : parser->fname,
2403 (parser->fname == NULL) ? "" : "()",
2404 maxargs,
2405 (nargs == 0) ? "keyword " : "",
2406 (maxargs == 1) ? "" : "s",
2407 nargs + nkwargs);
2408 return NULL;
2409 }
2410 if (nargs > maxpos) {
2411 if (maxpos == 0) {
2412 PyErr_Format(PyExc_TypeError,
2413 "%.200s%s takes no positional arguments",
2414 (parser->fname == NULL) ? "function" : parser->fname,
2415 (parser->fname == NULL) ? "" : "()");
2416 }
2417 else {
2418 PyErr_Format(PyExc_TypeError,
2419 "%.200s%s takes %s %d positional argument%s (%zd given)",
2420 (parser->fname == NULL) ? "function" : parser->fname,
2421 (parser->fname == NULL) ? "" : "()",
2422 (minpos < maxpos) ? "at most" : "exactly",
2423 maxpos,
2424 (maxpos == 1) ? "" : "s",
2425 nargs);
2426 }
2427 return NULL;
2428 }
2429 if (nargs < minposonly) {
2430 PyErr_Format(PyExc_TypeError,
2431 "%.200s%s takes %s %d positional argument%s"
2432 " (%zd given)",
2433 (parser->fname == NULL) ? "function" : parser->fname,
2434 (parser->fname == NULL) ? "" : "()",
2435 minposonly < maxpos ? "at least" : "exactly",
2436 minposonly,
2437 minposonly == 1 ? "" : "s",
2438 nargs);
2439 return NULL;
2440 }
2441
2442 /* copy tuple args */
2443 for (i = 0; i < nargs; i++) {
2444 buf[i] = args[i];
2445 }
2446
2447 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002448 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002449 if (nkwargs) {
2450 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2451 if (kwargs != NULL) {
2452 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2453 if (!current_arg && PyErr_Occurred()) {
2454 return NULL;
2455 }
2456 }
2457 else {
2458 current_arg = find_keyword(kwnames, kwstack, keyword);
2459 }
2460 }
2461 else if (i >= reqlimit) {
2462 break;
2463 }
2464 else {
2465 current_arg = NULL;
2466 }
2467
2468 buf[i] = current_arg;
2469
2470 if (current_arg) {
2471 --nkwargs;
2472 }
2473 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2474 /* Less arguments than required */
2475 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2476 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2477 "argument '%U' (pos %d)",
2478 (parser->fname == NULL) ? "function" : parser->fname,
2479 (parser->fname == NULL) ? "" : "()",
2480 keyword, i+1);
2481 return NULL;
2482 }
2483 }
2484
2485 if (nkwargs > 0) {
2486 Py_ssize_t j;
2487 /* make sure there are no arguments given by name and position */
2488 for (i = posonly; i < nargs; i++) {
2489 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2490 if (kwargs != NULL) {
2491 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2492 if (!current_arg && PyErr_Occurred()) {
2493 return NULL;
2494 }
2495 }
2496 else {
2497 current_arg = find_keyword(kwnames, kwstack, keyword);
2498 }
2499 if (current_arg) {
2500 /* arg present in tuple and in dict */
2501 PyErr_Format(PyExc_TypeError,
2502 "argument for %.200s%s given by name ('%U') "
2503 "and position (%d)",
2504 (parser->fname == NULL) ? "function" : parser->fname,
2505 (parser->fname == NULL) ? "" : "()",
2506 keyword, i+1);
2507 return NULL;
2508 }
2509 }
2510 /* make sure there are no extraneous keyword arguments */
2511 j = 0;
2512 while (1) {
2513 int match;
2514 if (kwargs != NULL) {
2515 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2516 break;
2517 }
2518 else {
2519 if (j >= PyTuple_GET_SIZE(kwnames))
2520 break;
2521 keyword = PyTuple_GET_ITEM(kwnames, j);
2522 j++;
2523 }
2524
Serhiy Storchaka31913912019-03-14 10:32:22 +02002525 match = PySequence_Contains(kwtuple, keyword);
2526 if (match <= 0) {
2527 if (!match) {
2528 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002529 "'%S' is an invalid keyword "
Serhiy Storchaka31913912019-03-14 10:32:22 +02002530 "argument for %.200s%s",
2531 keyword,
2532 (parser->fname == NULL) ? "this function" : parser->fname,
2533 (parser->fname == NULL) ? "" : "()");
2534 }
2535 return NULL;
2536 }
2537 }
2538 }
2539
2540 return buf;
2541}
2542
2543
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002544static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002545skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002546{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 const char *format = *p_format;
2548 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002549
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002551
Larry Hastingsa3479012012-05-08 23:52:03 -07002552 /*
2553 * codes that take a single data pointer as an argument
2554 * (the type of the pointer is irrelevant)
2555 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002556
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002557 case 'b': /* byte -- very short int */
2558 case 'B': /* byte as bitfield */
2559 case 'h': /* short int */
2560 case 'H': /* short int as bitfield */
2561 case 'i': /* int */
2562 case 'I': /* int sized bitfield */
2563 case 'l': /* long int */
2564 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002565 case 'L': /* long long */
2566 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002567 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002568 case 'f': /* float */
2569 case 'd': /* double */
2570 case 'D': /* complex double */
2571 case 'c': /* char */
2572 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002573 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002574 case 'S': /* string object */
2575 case 'Y': /* string object */
2576 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002578 if (p_va != NULL) {
2579 (void) va_arg(*p_va, void *);
2580 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002581 break;
2582 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002583
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002584 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 case 'e': /* string with encoding */
2587 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002588 if (p_va != NULL) {
2589 (void) va_arg(*p_va, const char *);
2590 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002591 if (!(*format == 's' || *format == 't'))
2592 /* after 'e', only 's' and 't' is allowed */
2593 goto err;
2594 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002595 }
Stefan Krahf432a322017-08-21 13:09:59 +02002596 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002597
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 case 's': /* string */
2599 case 'z': /* string or None */
2600 case 'y': /* bytes */
2601 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002602 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 case 'w': /* buffer, read-write */
2604 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002605 if (p_va != NULL) {
2606 (void) va_arg(*p_va, char **);
2607 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002608 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002609 if (p_va != NULL) {
2610 if (flags & FLAG_SIZE_T)
2611 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002612 else {
2613 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2614 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2615 return NULL;
2616 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002617 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002618 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002619 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002620 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002621 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2622 && *format == '*')
2623 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002624 format++;
2625 }
2626 break;
2627 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002629 case 'O': /* object */
2630 {
2631 if (*format == '!') {
2632 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002633 if (p_va != NULL) {
2634 (void) va_arg(*p_va, PyTypeObject*);
2635 (void) va_arg(*p_va, PyObject **);
2636 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002637 }
2638 else if (*format == '&') {
2639 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002640 if (p_va != NULL) {
2641 (void) va_arg(*p_va, converter);
2642 (void) va_arg(*p_va, void *);
2643 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002644 format++;
2645 }
2646 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002647 if (p_va != NULL) {
2648 (void) va_arg(*p_va, PyObject **);
2649 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002650 }
2651 break;
2652 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002654 case '(': /* bypass tuple, not handled at all previously */
2655 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002656 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 for (;;) {
2658 if (*format==')')
2659 break;
2660 if (IS_END_OF_FORMAT(*format))
2661 return "Unmatched left paren in format "
2662 "string";
2663 msg = skipitem(&format, p_va, flags);
2664 if (msg)
2665 return msg;
2666 }
2667 format++;
2668 break;
2669 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 case ')':
2672 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002673
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002674 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002675err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002676 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002677
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002678 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 *p_format = format;
2681 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002682}
Fred Drakee4616e62001-10-23 21:09:29 +00002683
2684
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002685#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002686
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002687int
2688_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2689 Py_ssize_t min, Py_ssize_t max)
2690{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002691 assert(min >= 0);
2692 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002693
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002694 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 if (name != NULL)
2696 PyErr_Format(
2697 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302698 "%.200s expected %s%zd argument%s, got %zd",
2699 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002700 else
2701 PyErr_Format(
2702 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302703 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002704 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302705 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002706 return 0;
2707 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002708
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002709 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002710 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002711 }
2712
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002713 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 if (name != NULL)
2715 PyErr_Format(
2716 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302717 "%.200s expected %s%zd argument%s, got %zd",
2718 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002719 else
2720 PyErr_Format(
2721 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302722 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002723 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302724 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 return 0;
2726 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002727
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002728 return 1;
2729}
2730
2731static int
2732unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2733 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2734{
2735 Py_ssize_t i;
2736 PyObject **o;
2737
2738 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2739 return 0;
2740 }
2741
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002742 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002743 o = va_arg(vargs, PyObject **);
2744 *o = args[i];
2745 }
2746 return 1;
2747}
2748
2749int
2750PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2751{
2752 PyObject **stack;
2753 Py_ssize_t nargs;
2754 int retval;
2755 va_list vargs;
2756
2757 if (!PyTuple_Check(args)) {
2758 PyErr_SetString(PyExc_SystemError,
2759 "PyArg_UnpackTuple() argument list is not a tuple");
2760 return 0;
2761 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002762 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002763 nargs = PyTuple_GET_SIZE(args);
2764
Raymond Hettinger94230232016-03-26 03:02:48 -07002765#ifdef HAVE_STDARG_PROTOTYPES
2766 va_start(vargs, max);
2767#else
2768 va_start(vargs);
2769#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002770 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002771 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002772 return retval;
2773}
2774
2775int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002776_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002777 Py_ssize_t min, Py_ssize_t max, ...)
2778{
2779 int retval;
2780 va_list vargs;
2781
2782#ifdef HAVE_STDARG_PROTOTYPES
2783 va_start(vargs, max);
2784#else
2785 va_start(vargs);
2786#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002787 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002788 va_end(vargs);
2789 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002790}
Georg Brandl02c42872005-08-26 06:42:30 +00002791
2792
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002793#undef _PyArg_NoKeywords
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002794#undef _PyArg_NoKwnames
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002795#undef _PyArg_NoPositional
2796
Georg Brandl02c42872005-08-26 06:42:30 +00002797/* For type constructors that don't take keyword args
2798 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002799 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002800 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002801 */
2802int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002803_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002804{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002805 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002806 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002807 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002808 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002809 PyErr_BadInternalCall();
2810 return 0;
2811 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002812 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002813 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002814 }
2815
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002816 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002817 funcname);
2818 return 0;
2819}
2820
Victor Stinner29d39cc2017-01-17 01:40:01 +01002821int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002822_PyArg_NoPositional(const char *funcname, PyObject *args)
2823{
2824 if (args == NULL)
2825 return 1;
2826 if (!PyTuple_CheckExact(args)) {
2827 PyErr_BadInternalCall();
2828 return 0;
2829 }
2830 if (PyTuple_GET_SIZE(args) == 0)
2831 return 1;
2832
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002833 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002834 funcname);
2835 return 0;
2836}
2837
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002838int
2839_PyArg_NoKwnames(const char *funcname, PyObject *kwnames)
2840{
2841 if (kwnames == NULL) {
2842 return 1;
2843 }
2844
2845 assert(PyTuple_CheckExact(kwnames));
2846
2847 if (PyTuple_GET_SIZE(kwnames) == 0) {
2848 return 1;
2849 }
2850
2851 PyErr_Format(PyExc_TypeError, "%s() takes no keyword arguments", funcname);
2852 return 0;
2853}
2854
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002855void
2856_PyArg_Fini(void)
2857{
2858 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2859 while (s) {
2860 tmp = s->next;
2861 s->next = NULL;
2862 parser_clear(s);
2863 s = tmp;
2864 }
2865 static_arg_parsers = NULL;
2866}
2867
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002868#ifdef __cplusplus
2869};
2870#endif