blob: cf0cc0783687ae5cfeb2c7e7fd9ab9a0df6e2840 [file] [log] [blame]
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001
2/* New getargs implementation */
3
Guido van Rossum79f25d91997-04-29 20:08:16 +00004#include "Python.h"
Victor Stinnerec13b932018-11-25 23:56:17 +01005#include "pycore_tupleobject.h"
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00006
Guido van Rossumc1d50531996-08-21 23:38:24 +00007#include <ctype.h>
Benjamin Petersona853a8b2017-09-07 11:13:59 -07008#include <float.h>
Guido van Rossumc1d50531996-08-21 23:38:24 +00009
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000010
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000011#ifdef __cplusplus
Guido van Rossum98297ee2007-11-06 21:34:58 +000012extern "C" {
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000013#endif
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000014int PyArg_Parse(PyObject *, const char *, ...);
15int PyArg_ParseTuple(PyObject *, const char *, ...);
16int PyArg_VaParse(PyObject *, const char *, va_list);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000017
Tim Petersdbd9ba62000-07-09 03:09:57 +000018int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000019 const char *, char **, ...);
Brett Cannon711e7d92004-07-10 22:20:32 +000020int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000021 const char *, char **, va_list);
Brett Cannon711e7d92004-07-10 22:20:32 +000022
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030023int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *,
24 struct _PyArg_Parser *, ...);
25int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *,
26 struct _PyArg_Parser *, va_list);
27
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000028#ifdef HAVE_DECLSPEC_DLL
29/* Export functions */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020030PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020031PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010032 const char *format, ...);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020033PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs,
34 PyObject *kwnames,
Benjamin Peterson819a46f2016-09-09 20:45:06 -070035 struct _PyArg_Parser *parser, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020036PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000037PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
38 const char *, char **, ...);
39PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020040PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000041PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *,
42 const char *, char **, va_list);
Benjamin Peterson4eef5052016-09-10 17:04:36 -070043
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030044PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
45 struct _PyArg_Parser *, ...);
46PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *,
47 struct _PyArg_Parser *, va_list);
Thomas Wouters49fd7fa2006-04-21 10:40:58 +000048#endif
49
Martin v. Löwis18e16552006-02-15 17:27:45 +000050#define FLAG_COMPAT 1
51#define FLAG_SIZE_T 2
52
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040053typedef int (*destr_t)(PyObject *, void *);
54
55
56/* Keep track of "objects" that have been allocated or initialized and
57 which will need to be deallocated or cleaned up somehow if overall
58 parsing fails.
59*/
60typedef struct {
61 void *item;
62 destr_t destructor;
63} freelistentry_t;
64
65typedef struct {
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040066 freelistentry_t *entries;
Antoine Pitrou7056cb22013-02-17 01:04:57 +010067 int first_available;
68 int entries_malloced;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -040069} freelist_t;
70
Antoine Pitrou7056cb22013-02-17 01:04:57 +010071#define STATIC_FREELIST_ENTRIES 8
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000072
73/* Forward */
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020074static int vgetargs1_impl(PyObject *args, PyObject *const *stack, Py_ssize_t nargs,
Victor Stinner6518a932017-01-17 01:29:49 +010075 const char *format, va_list *p_va, int flags);
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000076static int vgetargs1(PyObject *, const char *, va_list *, int);
Victor Stinner84bb1cf2013-05-17 00:12:04 +020077static void seterror(Py_ssize_t, const char *, int *, const char *, const char *);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020078static const char *convertitem(PyObject *, const char **, va_list *, int, int *,
79 char *, size_t, freelist_t *);
80static const char *converttuple(PyObject *, const char **, va_list *, int,
81 int *, char *, size_t, int, freelist_t *);
82static const char *convertsimple(PyObject *, const char **, va_list *, int,
83 char *, size_t, freelist_t *);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +020084static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020085static int getbuffer(PyObject *, Py_buffer *, const char**);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000086
Tim Petersdbd9ba62000-07-09 03:09:57 +000087static int vgetargskeywords(PyObject *, PyObject *,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000088 const char *, char **, va_list *, int);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +030089static int vgetargskeywordsfast(PyObject *, PyObject *,
90 struct _PyArg_Parser *, va_list *, int);
Serhiy Storchakaa5552f02017-12-15 13:11:11 +020091static int vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -070092 PyObject *keywords, PyObject *kwnames,
93 struct _PyArg_Parser *parser,
94 va_list *p_va, int flags);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +020095static const char *skipitem(const char **, va_list *, int);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000096
Fred Drake563dfc22001-10-23 14:41:08 +000097int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +000098PyArg_Parse(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +000099{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000100 int retval;
101 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000102
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000103 va_start(va, format);
104 retval = vgetargs1(args, format, &va, FLAG_COMPAT);
105 va_end(va);
106 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000107}
108
Vinay Sajip0b60f642019-10-15 08:26:12 +0100109PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200110_PyArg_Parse_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000111{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000112 int retval;
113 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000114
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000115 va_start(va, format);
116 retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T);
117 va_end(va);
118 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000119}
120
121
Fred Drake563dfc22001-10-23 14:41:08 +0000122int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000123PyArg_ParseTuple(PyObject *args, const char *format, ...)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000124{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000125 int retval;
126 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000128 va_start(va, format);
129 retval = vgetargs1(args, format, &va, 0);
130 va_end(va);
131 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000132}
133
Vinay Sajip0b60f642019-10-15 08:26:12 +0100134PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200135_PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000136{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000137 int retval;
138 va_list va;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000140 va_start(va, format);
141 retval = vgetargs1(args, format, &va, FLAG_SIZE_T);
142 va_end(va);
143 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000144}
145
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000146
147int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200148_PyArg_ParseStack(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100149{
150 int retval;
151 va_list va;
152
153 va_start(va, format);
154 retval = vgetargs1_impl(NULL, args, nargs, format, &va, 0);
155 va_end(va);
156 return retval;
157}
158
Vinay Sajip0b60f642019-10-15 08:26:12 +0100159PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200160_PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs, const char *format, ...)
Victor Stinner6518a932017-01-17 01:29:49 +0100161{
162 int retval;
163 va_list va;
164
165 va_start(va, format);
166 retval = vgetargs1_impl(NULL, args, nargs, format, &va, FLAG_SIZE_T);
167 va_end(va);
168 return retval;
169}
170
171
172int
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000173PyArg_VaParse(PyObject *args, const char *format, va_list va)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000174{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000175 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200176 int retval;
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000177
Benjamin Peterson0c212142016-09-20 20:39:33 -0700178 va_copy(lva, va);
Guido van Rossum1ae940a1995-01-02 19:04:15 +0000179
Christian Heimes2f2fee12016-09-21 11:37:27 +0200180 retval = vgetargs1(args, format, &lva, 0);
181 va_end(lva);
182 return retval;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000183}
184
Vinay Sajip0b60f642019-10-15 08:26:12 +0100185PyAPI_FUNC(int)
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200186_PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +0000187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000188 va_list lva;
Christian Heimes2f2fee12016-09-21 11:37:27 +0200189 int retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000190
Benjamin Peterson0c212142016-09-20 20:39:33 -0700191 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +0000192
Christian Heimes2f2fee12016-09-21 11:37:27 +0200193 retval = vgetargs1(args, format, &lva, FLAG_SIZE_T);
194 va_end(lva);
195 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000196}
197
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000198
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000199/* Handle cleanup of allocated memory in case of exception */
200
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400201static int
202cleanup_ptr(PyObject *self, void *ptr)
Antoine Pitrouf71995782008-08-29 18:37:05 +0000203{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 if (ptr) {
205 PyMem_FREE(ptr);
206 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000207 return 0;
Martin v. Löwisc15bdef2009-05-29 14:47:46 +0000208}
209
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000210static int
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400211cleanup_buffer(PyObject *self, void *ptr)
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000212{
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400213 Py_buffer *buf = (Py_buffer *)ptr;
214 if (buf) {
215 PyBuffer_Release(buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000216 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400217 return 0;
218}
219
220static int
221addcleanup(void *ptr, freelist_t *freelist, destr_t destructor)
222{
223 int index;
224
225 index = freelist->first_available;
226 freelist->first_available += 1;
227
228 freelist->entries[index].item = ptr;
229 freelist->entries[index].destructor = destructor;
230
231 return 0;
232}
233
234static int
235cleanreturn(int retval, freelist_t *freelist)
236{
237 int index;
238
239 if (retval == 0) {
240 /* A failure occurred, therefore execute all of the cleanup
241 functions.
242 */
243 for (index = 0; index < freelist->first_available; ++index) {
244 freelist->entries[index].destructor(NULL,
245 freelist->entries[index].item);
246 }
247 }
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100248 if (freelist->entries_malloced)
249 PyMem_FREE(freelist->entries);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000250 return retval;
Martin v. Löwise6bbb4d2003-05-03 10:00:22 +0000251}
252
253
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000254static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +0200255vgetargs1_impl(PyObject *compat_args, PyObject *const *stack, Py_ssize_t nargs, const char *format,
Victor Stinner6518a932017-01-17 01:29:49 +0100256 va_list *p_va, int flags)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000257{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000258 char msgbuf[256];
259 int levels[32];
260 const char *fname = NULL;
261 const char *message = NULL;
262 int min = -1;
263 int max = 0;
264 int level = 0;
265 int endfmt = 0;
266 const char *formatsave = format;
Victor Stinner6518a932017-01-17 01:29:49 +0100267 Py_ssize_t i;
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200268 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000269 int compat = flags & FLAG_COMPAT;
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500270 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
271 freelist_t freelist;
272
Victor Stinner6518a932017-01-17 01:29:49 +0100273 assert(nargs == 0 || stack != NULL);
274
Benjamin Peterson40be9e52014-02-11 10:09:27 -0500275 freelist.entries = static_entries;
276 freelist.first_available = 0;
277 freelist.entries_malloced = 0;
Martin v. Löwis18e16552006-02-15 17:27:45 +0000278
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000279 flags = flags & ~FLAG_COMPAT;
Tim Peters5c4d5bf2001-02-12 22:13:26 +0000280
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000281 while (endfmt == 0) {
282 int c = *format++;
283 switch (c) {
284 case '(':
285 if (level == 0)
286 max++;
287 level++;
288 if (level >= 30)
289 Py_FatalError("too many tuple nesting levels "
290 "in argument format string");
291 break;
292 case ')':
293 if (level == 0)
294 Py_FatalError("excess ')' in getargs format");
295 else
296 level--;
297 break;
298 case '\0':
299 endfmt = 1;
300 break;
301 case ':':
302 fname = format;
303 endfmt = 1;
304 break;
305 case ';':
306 message = format;
307 endfmt = 1;
308 break;
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100309 case '|':
310 if (level == 0)
311 min = max;
312 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000313 default:
314 if (level == 0) {
Jordon Xu2ec70102019-09-11 00:04:08 +0800315 if (Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000316 if (c != 'e') /* skip encoded */
317 max++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000318 }
319 break;
320 }
321 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000322
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000323 if (level != 0)
324 Py_FatalError(/* '(' */ "missing ')' in getargs format");
Guido van Rossum98297ee2007-11-06 21:34:58 +0000325
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000326 if (min < 0)
327 min = max;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000328
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000329 format = formatsave;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000330
Antoine Pitrou7056cb22013-02-17 01:04:57 +0100331 if (max > STATIC_FREELIST_ENTRIES) {
332 freelist.entries = PyMem_NEW(freelistentry_t, max);
333 if (freelist.entries == NULL) {
334 PyErr_NoMemory();
335 return 0;
336 }
337 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -0500338 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400339
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 if (compat) {
341 if (max == 0) {
Victor Stinner6518a932017-01-17 01:29:49 +0100342 if (compat_args == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000343 return 1;
Victor Stinner6ced7c42011-03-21 18:15:42 +0100344 PyErr_Format(PyExc_TypeError,
345 "%.200s%s takes no arguments",
346 fname==NULL ? "function" : fname,
347 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400348 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000349 }
350 else if (min == 1 && max == 1) {
Victor Stinner6518a932017-01-17 01:29:49 +0100351 if (compat_args == NULL) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100352 PyErr_Format(PyExc_TypeError,
353 "%.200s%s takes at least one argument",
354 fname==NULL ? "function" : fname,
355 fname==NULL ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400356 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000357 }
Victor Stinner6518a932017-01-17 01:29:49 +0100358 msg = convertitem(compat_args, &format, p_va, flags, levels,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 msgbuf, sizeof(msgbuf), &freelist);
360 if (msg == NULL)
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400361 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000362 seterror(levels[0], msg, levels+1, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400363 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 }
365 else {
366 PyErr_SetString(PyExc_SystemError,
367 "old style getargs format uses new features");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400368 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000369 }
370 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000371
Victor Stinner6518a932017-01-17 01:29:49 +0100372 if (nargs < min || max < nargs) {
Victor Stinner6ced7c42011-03-21 18:15:42 +0100373 if (message == NULL)
374 PyErr_Format(PyExc_TypeError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200375 "%.150s%s takes %s %d argument%s (%zd given)",
Victor Stinner6ced7c42011-03-21 18:15:42 +0100376 fname==NULL ? "function" : fname,
377 fname==NULL ? "" : "()",
378 min==max ? "exactly"
Victor Stinner6518a932017-01-17 01:29:49 +0100379 : nargs < min ? "at least" : "at most",
380 nargs < min ? min : max,
381 (nargs < min ? min : max) == 1 ? "" : "s",
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +0200382 nargs);
Victor Stinner6ced7c42011-03-21 18:15:42 +0100383 else
384 PyErr_SetString(PyExc_TypeError, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400385 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000386 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000387
Victor Stinner6518a932017-01-17 01:29:49 +0100388 for (i = 0; i < nargs; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000389 if (*format == '|')
390 format++;
Victor Stinner6518a932017-01-17 01:29:49 +0100391 msg = convertitem(stack[i], &format, p_va,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000392 flags, levels, msgbuf,
393 sizeof(msgbuf), &freelist);
394 if (msg) {
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200395 seterror(i+1, msg, levels, fname, message);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400396 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000397 }
398 }
Guido van Rossum231a41e1997-12-09 20:36:39 +0000399
Jordon Xu2ec70102019-09-11 00:04:08 +0800400 if (*format != '\0' && !Py_ISALPHA(*format) &&
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000401 *format != '(' &&
402 *format != '|' && *format != ':' && *format != ';') {
403 PyErr_Format(PyExc_SystemError,
404 "bad format string: %.200s", formatsave);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400405 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000406 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000407
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400408 return cleanreturn(1, &freelist);
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000409}
410
Victor Stinner6518a932017-01-17 01:29:49 +0100411static int
412vgetargs1(PyObject *args, const char *format, va_list *p_va, int flags)
413{
414 PyObject **stack;
415 Py_ssize_t nargs;
416
417 if (!(flags & FLAG_COMPAT)) {
418 assert(args != NULL);
419
420 if (!PyTuple_Check(args)) {
421 PyErr_SetString(PyExc_SystemError,
422 "new style getargs format but argument is not a tuple");
423 return 0;
424 }
425
Victor Stinnerd17a6932018-11-09 16:56:48 +0100426 stack = _PyTuple_ITEMS(args);
Victor Stinner6518a932017-01-17 01:29:49 +0100427 nargs = PyTuple_GET_SIZE(args);
428 }
429 else {
430 stack = NULL;
431 nargs = 0;
432 }
433
434 return vgetargs1_impl(args, stack, nargs, format, p_va, flags);
435}
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000436
437
438static void
Victor Stinner84bb1cf2013-05-17 00:12:04 +0200439seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000440 const char *message)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000441{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000442 char buf[512];
443 int i;
444 char *p = buf;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000446 if (PyErr_Occurred())
447 return;
448 else if (message == NULL) {
449 if (fname != NULL) {
450 PyOS_snprintf(p, sizeof(buf), "%.200s() ", fname);
451 p += strlen(p);
452 }
453 if (iarg != 0) {
454 PyOS_snprintf(p, sizeof(buf) - (p - buf),
Victor Stinnerd36cf5f2020-06-10 18:38:05 +0200455 "argument %zd", iarg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000456 i = 0;
457 p += strlen(p);
Georg Brandl142ad662013-10-14 07:01:11 +0200458 while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000459 PyOS_snprintf(p, sizeof(buf) - (p - buf),
460 ", item %d", levels[i]-1);
461 p += strlen(p);
462 i++;
463 }
464 }
465 else {
466 PyOS_snprintf(p, sizeof(buf) - (p - buf), "argument");
467 p += strlen(p);
468 }
469 PyOS_snprintf(p, sizeof(buf) - (p - buf), " %.256s", msg);
470 message = buf;
471 }
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +0200472 if (msg[0] == '(') {
473 PyErr_SetString(PyExc_SystemError, message);
474 }
475 else {
476 PyErr_SetString(PyExc_TypeError, message);
477 }
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000478}
479
480
481/* Convert a tuple argument.
482 On entry, *p_format points to the character _after_ the opening '('.
483 On successful exit, *p_format points to the closing ')'.
484 If successful:
485 *p_format and *p_va are updated,
486 *levels and *msgbuf are untouched,
487 and NULL is returned.
488 If the argument is invalid:
489 *p_format is unchanged,
490 *p_va is undefined,
491 *levels is a 0-terminated list of item numbers,
492 *msgbuf contains an error message, whose format is:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000493 "must be <typename1>, not <typename2>", where:
494 <typename1> is the name of the expected type, and
495 <typename2> is the name of the actual type,
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000496 and msgbuf is returned.
497*/
498
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200499static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000500converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Guido van Rossum98297ee2007-11-06 21:34:58 +0000501 int *levels, char *msgbuf, size_t bufsize, int toplevel,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400502 freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000504 int level = 0;
505 int n = 0;
506 const char *format = *p_format;
507 int i;
Victor Stinner74387f52013-11-18 01:21:12 +0100508 Py_ssize_t len;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000509
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000510 for (;;) {
511 int c = *format++;
512 if (c == '(') {
513 if (level == 0)
514 n++;
515 level++;
516 }
517 else if (c == ')') {
518 if (level == 0)
519 break;
520 level--;
521 }
522 else if (c == ':' || c == ';' || c == '\0')
523 break;
Jordon Xu2ec70102019-09-11 00:04:08 +0800524 else if (level == 0 && Py_ISALPHA(c))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000525 n++;
526 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000527
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000528 if (!PySequence_Check(arg) || PyBytes_Check(arg)) {
529 levels[0] = 0;
530 PyOS_snprintf(msgbuf, bufsize,
531 toplevel ? "expected %d arguments, not %.50s" :
532 "must be %d-item sequence, not %.50s",
533 n,
Victor Stinnera102ed72020-02-07 02:24:48 +0100534 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000535 return msgbuf;
536 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000537
Victor Stinner74387f52013-11-18 01:21:12 +0100538 len = PySequence_Size(arg);
539 if (len != n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000540 levels[0] = 0;
Victor Stinner74387f52013-11-18 01:21:12 +0100541 if (toplevel) {
542 PyOS_snprintf(msgbuf, bufsize,
Victor Stinnerd36cf5f2020-06-10 18:38:05 +0200543 "expected %d argument%s, not %zd",
Xtreak63262782018-12-21 20:15:13 +0530544 n,
545 n == 1 ? "" : "s",
546 len);
Victor Stinner74387f52013-11-18 01:21:12 +0100547 }
548 else {
549 PyOS_snprintf(msgbuf, bufsize,
Victor Stinnerd36cf5f2020-06-10 18:38:05 +0200550 "must be sequence of length %d, not %zd",
Victor Stinner74387f52013-11-18 01:21:12 +0100551 n, len);
552 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000553 return msgbuf;
554 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000555
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000556 format = *p_format;
557 for (i = 0; i < n; i++) {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200558 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000559 PyObject *item;
560 item = PySequence_GetItem(arg, i);
561 if (item == NULL) {
562 PyErr_Clear();
563 levels[0] = i+1;
564 levels[1] = 0;
565 strncpy(msgbuf, "is not retrievable", bufsize);
566 return msgbuf;
567 }
568 msg = convertitem(item, &format, p_va, flags, levels+1,
569 msgbuf, bufsize, freelist);
570 /* PySequence_GetItem calls tp->sq_item, which INCREFs */
571 Py_XDECREF(item);
572 if (msg != NULL) {
573 levels[0] = i+1;
574 return msg;
575 }
576 }
Ka-Ping Yee20579702001-01-15 22:14:16 +0000577
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000578 *p_format = format;
579 return NULL;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000580}
581
582
583/* Convert a single item. */
584
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200585static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000586convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400587 int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000588{
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200589 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000590 const char *format = *p_format;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000591
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000592 if (*format == '(' /* ')' */) {
593 format++;
594 msg = converttuple(arg, &format, p_va, flags, levels, msgbuf,
595 bufsize, 0, freelist);
596 if (msg == NULL)
597 format++;
598 }
599 else {
600 msg = convertsimple(arg, &format, p_va, flags,
601 msgbuf, bufsize, freelist);
602 if (msg != NULL)
603 levels[0] = 0;
604 }
605 if (msg == NULL)
606 *p_format = format;
607 return msg;
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000608}
609
610
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000611
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200612/* Format an error message generated by convertsimple().
613 displayname must be UTF-8 encoded.
614*/
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000615
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200616void
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200617_PyArg_BadArgument(const char *fname, const char *displayname,
Serhiy Storchaka4fa95912019-01-11 16:01:14 +0200618 const char *expected, PyObject *arg)
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200619{
Rémi Lapeyre4901fe22019-08-29 16:49:08 +0200620 PyErr_Format(PyExc_TypeError,
621 "%.200s() %.200s must be %.50s, not %.50s",
622 fname, displayname, expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100623 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchaka32d96a22018-12-25 13:23:47 +0200624}
625
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200626static const char *
Jeremy Hyltonaf68c872005-12-10 18:50:16 +0000627converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000628{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000629 assert(expected != NULL);
630 assert(arg != NULL);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200631 if (expected[0] == '(') {
632 PyOS_snprintf(msgbuf, bufsize,
633 "%.100s", expected);
634 }
635 else {
636 PyOS_snprintf(msgbuf, bufsize,
637 "must be %.50s, not %.50s", expected,
Victor Stinnera102ed72020-02-07 02:24:48 +0100638 arg == Py_None ? "None" : Py_TYPE(arg)->tp_name);
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200639 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000640 return msgbuf;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000641}
642
643#define CONV_UNICODE "(unicode conversion error)"
644
645/* Convert a non-tuple argument. Return NULL if conversion went OK,
646 or a string with a message describing the failure. The message is
647 formatted as "must be <desired type>, not <actual type>".
648 When failing, an exception may or may not have been raised.
Georg Brandl6dd14612005-09-14 19:29:53 +0000649 Don't call if a tuple is expected.
650
651 When you add new format codes, please don't forget poor skipitem() below.
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000652*/
653
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200654static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +0000655convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags,
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400656 char *msgbuf, size_t bufsize, freelist_t *freelist)
Guido van Rossumfe3f1a21994-09-29 09:42:55 +0000657{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000658 /* For # codes */
659#define FETCH_SIZE int *q=NULL;Py_ssize_t *q2=NULL;\
660 if (flags & FLAG_SIZE_T) q2=va_arg(*p_va, Py_ssize_t*); \
Inada Naokid3c72a22019-03-23 21:04:40 +0900661 else { \
662 if (PyErr_WarnEx(PyExc_DeprecationWarning, \
663 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) { \
664 return NULL; \
665 } \
666 q=va_arg(*p_va, int*); \
667 }
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000668#define STORE_SIZE(s) \
669 if (flags & FLAG_SIZE_T) \
670 *q2=s; \
671 else { \
672 if (INT_MAX < s) { \
673 PyErr_SetString(PyExc_OverflowError, \
674 "size does not fit in an int"); \
675 return converterr("", arg, msgbuf, bufsize); \
676 } \
Victor Stinner9550ef32013-06-05 01:18:13 +0200677 *q = (int)s; \
Victor Stinnerb3c9e072011-01-04 02:07:34 +0000678 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000679#define BUFFER_LEN ((flags & FLAG_SIZE_T) ? *q2:*q)
Victor Stinner6ab8e822011-01-04 11:16:49 +0000680#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000681
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 const char *format = *p_format;
683 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200684 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000685
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000686 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000687
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000688 case 'b': { /* unsigned byte -- very short int */
689 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300690 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000691 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000692 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 else if (ival < 0) {
694 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000695 "unsigned byte integer is less than minimum");
696 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000697 }
698 else if (ival > UCHAR_MAX) {
699 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000700 "unsigned byte integer is greater than maximum");
701 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000702 }
703 else
704 *p = (unsigned char) ival;
705 break;
706 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000707
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000708 case 'B': {/* byte sized bitfield - both signed and unsigned
709 values allowed */
710 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300711 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
712 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000713 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000714 else
715 *p = (unsigned char) ival;
716 break;
717 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000718
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000719 case 'h': {/* signed short int */
720 short *p = va_arg(*p_va, short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300721 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000722 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000723 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 else if (ival < SHRT_MIN) {
725 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000726 "signed short integer is less than minimum");
727 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000728 }
729 else if (ival > SHRT_MAX) {
730 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000731 "signed short integer is greater than maximum");
732 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000733 }
734 else
735 *p = (short) ival;
736 break;
737 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000738
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000739 case 'H': { /* short int sized bitfield, both signed and
740 unsigned allowed */
741 unsigned short *p = va_arg(*p_va, unsigned short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300742 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
743 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000744 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000745 else
746 *p = (unsigned short) ival;
747 break;
748 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000750 case 'i': {/* signed int */
751 int *p = va_arg(*p_va, int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300752 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000753 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000754 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 else if (ival > INT_MAX) {
756 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000757 "signed integer is greater than maximum");
758 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000759 }
760 else if (ival < INT_MIN) {
761 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000762 "signed integer is less than minimum");
763 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000764 }
765 else
766 *p = ival;
767 break;
768 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000769
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000770 case 'I': { /* int sized bitfield, both signed and
771 unsigned allowed */
772 unsigned int *p = va_arg(*p_va, unsigned int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300773 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
774 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000775 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000776 else
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300777 *p = (unsigned int) ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 break;
779 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000780
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000781 case 'n': /* Py_ssize_t */
782 {
783 PyObject *iobj;
784 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
785 Py_ssize_t ival = -1;
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300786 iobj = _PyNumber_Index(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000787 if (iobj != NULL) {
788 ival = PyLong_AsSsize_t(iobj);
789 Py_DECREF(iobj);
790 }
791 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000792 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000793 *p = ival;
794 break;
795 }
796 case 'l': {/* long int */
797 long *p = va_arg(*p_va, long *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300798 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000799 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000800 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000801 else
802 *p = ival;
803 break;
804 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000805
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000806 case 'k': { /* long sized bitfield */
807 unsigned long *p = va_arg(*p_va, unsigned long *);
808 unsigned long ival;
809 if (PyLong_Check(arg))
810 ival = PyLong_AsUnsignedLongMask(arg);
811 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200812 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000813 *p = ival;
814 break;
815 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000816
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700817 case 'L': {/* long long */
818 long long *p = va_arg( *p_va, long long * );
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300819 long long ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700820 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000821 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000822 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000824 break;
825 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000826
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000827 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700828 unsigned long long *p = va_arg(*p_va, unsigned long long *);
829 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000830 if (PyLong_Check(arg))
831 ival = PyLong_AsUnsignedLongLongMask(arg);
832 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200833 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000834 *p = ival;
835 break;
836 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000837
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 case 'f': {/* float */
839 float *p = va_arg(*p_va, float *);
840 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700841 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000842 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 else
844 *p = (float) dval;
845 break;
846 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000847
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000848 case 'd': {/* double */
849 double *p = va_arg(*p_va, double *);
850 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700851 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000852 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000853 else
854 *p = dval;
855 break;
856 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000857
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000858 case 'D': {/* complex double */
859 Py_complex *p = va_arg(*p_va, Py_complex *);
860 Py_complex cval;
861 cval = PyComplex_AsCComplex(arg);
862 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000863 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000864 else
865 *p = cval;
866 break;
867 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000868
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000869 case 'c': {/* char */
870 char *p = va_arg(*p_va, char *);
871 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
872 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300873 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
874 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000875 else
876 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
877 break;
878 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000879
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000880 case 'C': {/* unicode char */
881 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200882 int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +0300883 const void *data;
Victor Stinnere1335c72011-10-04 20:53:03 +0200884
885 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000886 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200887
888 if (PyUnicode_READY(arg))
889 RETURN_ERR_OCCURRED;
890
891 if (PyUnicode_GET_LENGTH(arg) != 1)
892 return converterr("a unicode character", arg, msgbuf, bufsize);
893
894 kind = PyUnicode_KIND(arg);
895 data = PyUnicode_DATA(arg);
896 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000897 break;
898 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000899
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700900 case 'p': {/* boolean *p*redicate */
901 int *p = va_arg(*p_va, int *);
902 int val = PyObject_IsTrue(arg);
903 if (val > 0)
904 *p = 1;
905 else if (val == 0)
906 *p = 0;
907 else
908 RETURN_ERR_OCCURRED;
909 break;
910 }
911
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000912 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000913 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000914
Serhiy Storchakab757c832014-12-05 22:25:22 +0200915 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200917 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000918 Py_ssize_t count;
919 if (*format == '*') {
920 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
921 return converterr(buf, arg, msgbuf, bufsize);
922 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400923 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000924 return converterr(
925 "(cleanup problem)",
926 arg, msgbuf, bufsize);
927 }
928 break;
929 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200930 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000931 if (count < 0)
932 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000933 if (*format == '#') {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000934 FETCH_SIZE;
935 STORE_SIZE(count);
936 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000937 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300938 if (strlen(*p) != (size_t)count) {
939 PyErr_SetString(PyExc_ValueError, "embedded null byte");
940 RETURN_ERR_OCCURRED;
941 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000942 }
943 break;
944 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000945
Serhiy Storchakab757c832014-12-05 22:25:22 +0200946 case 's': /* text string or bytes-like object */
947 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000948 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000949 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000950 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000952
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000953 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000954 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
955 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200956 Py_ssize_t len;
957 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
958 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000959 return converterr(CONV_UNICODE,
960 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200961 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000962 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200963 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200964 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000965 if (getbuffer(arg, p, &buf) < 0)
966 return converterr(buf, arg, msgbuf, bufsize);
967 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400968 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 return converterr(
970 "(cleanup problem)",
971 arg, msgbuf, bufsize);
972 }
973 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200974 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000975 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200976 const void **p = (const void **)va_arg(*p_va, const char **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000977 FETCH_SIZE;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000978
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000979 if (c == 'z' && arg == Py_None) {
980 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000981 STORE_SIZE(0);
982 }
983 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200984 Py_ssize_t len;
985 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
986 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000987 return converterr(CONV_UNICODE,
988 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200989 *p = sarg;
990 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000991 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200992 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000993 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200994 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000995 Py_ssize_t count = convertbuffer(arg, p, &buf);
996 if (count < 0)
997 return converterr(buf, arg, msgbuf, bufsize);
998 STORE_SIZE(count);
999 }
1000 format++;
1001 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001002 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001003 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001004 Py_ssize_t len;
1005 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001006
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001007 if (c == 'z' && arg == Py_None)
1008 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001010 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
1011 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001012 return converterr(CONV_UNICODE,
1013 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001014 if (strlen(sarg) != (size_t)len) {
1015 PyErr_SetString(PyExc_ValueError, "embedded null character");
1016 RETURN_ERR_OCCURRED;
1017 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001018 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001019 }
1020 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001021 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001022 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001023 }
1024 break;
1025 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001026
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001027 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1028 case 'Z': /* raw unicode buffer or None */
1029 {
Inada Naoki2c4928d2020-06-17 20:09:44 +09001030 // TODO: Raise DeprecationWarning
1031_Py_COMP_DIAG_PUSH
1032_Py_COMP_DIAG_IGNORE_DEPR_DECLS
Brett Cannonb94767f2011-02-22 20:15:44 +00001033 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1034
Serhiy Storchakab757c832014-12-05 22:25:22 +02001035 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001036 /* "u#" or "Z#" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 FETCH_SIZE;
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001038
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001039 if (c == 'Z' && arg == Py_None) {
1040 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 STORE_SIZE(0);
1042 }
1043 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001044 Py_ssize_t len;
1045 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001046 if (*p == NULL)
1047 RETURN_ERR_OCCURRED;
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001048 STORE_SIZE(len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001049 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001050 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001051 return converterr(c == 'Z' ? "str or None" : "str",
1052 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001053 format++;
1054 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001055 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001056 if (c == 'Z' && arg == Py_None)
1057 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001058 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001059 Py_ssize_t len;
1060 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001061 if (*p == NULL)
1062 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001063 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001064 PyErr_SetString(PyExc_ValueError, "embedded null character");
1065 RETURN_ERR_OCCURRED;
1066 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001067 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001068 return converterr(c == 'Z' ? "str or None" : "str",
1069 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001070 }
1071 break;
Inada Naoki2c4928d2020-06-17 20:09:44 +09001072_Py_COMP_DIAG_POP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001073 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001074
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001075 case 'e': {/* encoded string */
1076 char **buffer;
1077 const char *encoding;
1078 PyObject *s;
1079 int recode_strings;
1080 Py_ssize_t size;
1081 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001083 /* Get 'e' parameter: the encoding name */
1084 encoding = (const char *)va_arg(*p_va, const char *);
1085 if (encoding == NULL)
1086 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001087
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001088 /* Get output buffer parameter:
1089 's' (recode all objects via Unicode) or
1090 't' (only recode non-string objects)
1091 */
1092 if (*format == 's')
1093 recode_strings = 1;
1094 else if (*format == 't')
1095 recode_strings = 0;
1096 else
1097 return converterr(
1098 "(unknown parser marker combination)",
1099 arg, msgbuf, bufsize);
1100 buffer = (char **)va_arg(*p_va, char **);
1101 format++;
1102 if (buffer == NULL)
1103 return converterr("(buffer is NULL)",
1104 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001105
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001106 /* Encode object */
1107 if (!recode_strings &&
1108 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1109 s = arg;
1110 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001111 if (PyBytes_Check(arg)) {
1112 size = PyBytes_GET_SIZE(s);
1113 ptr = PyBytes_AS_STRING(s);
1114 }
1115 else {
1116 size = PyByteArray_GET_SIZE(s);
1117 ptr = PyByteArray_AS_STRING(s);
1118 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001119 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001120 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001121 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001122 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001123 encoding,
1124 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001125 if (s == NULL)
1126 return converterr("(encoding failed)",
1127 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001128 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 size = PyBytes_GET_SIZE(s);
1130 ptr = PyBytes_AS_STRING(s);
1131 if (ptr == NULL)
1132 ptr = "";
1133 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001134 else {
1135 return converterr(
1136 recode_strings ? "str" : "str, bytes or bytearray",
1137 arg, msgbuf, bufsize);
1138 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001139
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001140 /* Write output; output is guaranteed to be 0-terminated */
1141 if (*format == '#') {
1142 /* Using buffer length parameter '#':
1143
1144 - if *buffer is NULL, a new buffer of the
1145 needed size is allocated and the data
1146 copied into it; *buffer is updated to point
1147 to the new buffer; the caller is
1148 responsible for PyMem_Free()ing it after
1149 usage
1150
1151 - if *buffer is not NULL, the data is
1152 copied to *buffer; *buffer_len has to be
1153 set to the size of the buffer on input;
1154 buffer overflow is signalled with an error;
1155 buffer has to provide enough room for the
1156 encoded string plus the trailing 0-byte
1157
1158 - in both cases, *buffer_len is updated to
1159 the size of the buffer /excluding/ the
1160 trailing 0-byte
1161
1162 */
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001163 int *q = NULL; Py_ssize_t *q2 = NULL;
1164 if (flags & FLAG_SIZE_T) {
1165 q2 = va_arg(*p_va, Py_ssize_t*);
1166 }
1167 else {
1168 if (PyErr_WarnEx(PyExc_DeprecationWarning,
1169 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1))
1170 {
1171 Py_DECREF(s);
1172 return NULL;
1173 }
1174 q = va_arg(*p_va, int*);
1175 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176
1177 format++;
1178 if (q == NULL && q2 == NULL) {
1179 Py_DECREF(s);
1180 return converterr(
1181 "(buffer_len is NULL)",
1182 arg, msgbuf, bufsize);
1183 }
1184 if (*buffer == NULL) {
1185 *buffer = PyMem_NEW(char, size + 1);
1186 if (*buffer == NULL) {
1187 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001188 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001189 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001191 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001192 Py_DECREF(s);
1193 return converterr(
1194 "(cleanup problem)",
1195 arg, msgbuf, bufsize);
1196 }
1197 } else {
1198 if (size + 1 > BUFFER_LEN) {
1199 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001200 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001201 "encoded string too long "
1202 "(%zd, maximum length %zd)",
1203 (Py_ssize_t)size, (Py_ssize_t)(BUFFER_LEN-1));
1204 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001205 }
1206 }
1207 memcpy(*buffer, ptr, size+1);
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001208
1209 if (flags & FLAG_SIZE_T) {
1210 *q2 = size;
1211 }
1212 else {
1213 if (INT_MAX < size) {
1214 Py_DECREF(s);
1215 PyErr_SetString(PyExc_OverflowError,
1216 "size does not fit in an int");
1217 return converterr("", arg, msgbuf, bufsize);
1218 }
1219 *q = (int)size;
1220 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001221 } else {
1222 /* Using a 0-terminated buffer:
1223
1224 - the encoded string has to be 0-terminated
1225 for this variant to work; if it is not, an
1226 error raised
1227
1228 - a new buffer of the needed size is
1229 allocated and the data copied into it;
1230 *buffer is updated to point to the new
1231 buffer; the caller is responsible for
1232 PyMem_Free()ing it after usage
1233
1234 */
1235 if ((Py_ssize_t)strlen(ptr) != size) {
1236 Py_DECREF(s);
1237 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001238 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001239 arg, msgbuf, bufsize);
1240 }
1241 *buffer = PyMem_NEW(char, size + 1);
1242 if (*buffer == NULL) {
1243 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001244 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001245 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001246 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001247 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 Py_DECREF(s);
1249 return converterr("(cleanup problem)",
1250 arg, msgbuf, bufsize);
1251 }
1252 memcpy(*buffer, ptr, size+1);
1253 }
1254 Py_DECREF(s);
1255 break;
1256 }
1257
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001258 case 'S': { /* PyBytes object */
1259 PyObject **p = va_arg(*p_va, PyObject **);
1260 if (PyBytes_Check(arg))
1261 *p = arg;
1262 else
1263 return converterr("bytes", arg, msgbuf, bufsize);
1264 break;
1265 }
1266
1267 case 'Y': { /* PyByteArray object */
1268 PyObject **p = va_arg(*p_va, PyObject **);
1269 if (PyByteArray_Check(arg))
1270 *p = arg;
1271 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001272 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001273 break;
1274 }
1275
1276 case 'U': { /* PyUnicode object */
1277 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001278 if (PyUnicode_Check(arg)) {
1279 if (PyUnicode_READY(arg) == -1)
1280 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001282 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001283 else
1284 return converterr("str", arg, msgbuf, bufsize);
1285 break;
1286 }
1287
1288 case 'O': { /* object */
1289 PyTypeObject *type;
1290 PyObject **p;
1291 if (*format == '!') {
1292 type = va_arg(*p_va, PyTypeObject*);
1293 p = va_arg(*p_va, PyObject **);
1294 format++;
Victor Stinnera102ed72020-02-07 02:24:48 +01001295 if (PyType_IsSubtype(Py_TYPE(arg), type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001296 *p = arg;
1297 else
1298 return converterr(type->tp_name, arg, msgbuf, bufsize);
1299
1300 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 else if (*format == '&') {
1302 typedef int (*converter)(PyObject *, void *);
1303 converter convert = va_arg(*p_va, converter);
1304 void *addr = va_arg(*p_va, void *);
1305 int res;
1306 format++;
1307 if (! (res = (*convert)(arg, addr)))
1308 return converterr("(unspecified)",
1309 arg, msgbuf, bufsize);
1310 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001311 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001312 return converterr("(cleanup problem)",
1313 arg, msgbuf, bufsize);
1314 }
1315 else {
1316 p = va_arg(*p_va, PyObject **);
1317 *p = arg;
1318 }
1319 break;
1320 }
1321
1322
Victor Stinner25e8ec42010-06-25 00:02:38 +00001323 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001324 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001325
Victor Stinner25e8ec42010-06-25 00:02:38 +00001326 if (*format != '*')
1327 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001328 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001329 arg, msgbuf, bufsize);
1330 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001331
Victor Stinner25e8ec42010-06-25 00:02:38 +00001332 /* Caller is interested in Py_buffer, and the object
1333 supports it directly. */
1334 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1335 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001336 return converterr("read-write bytes-like object",
1337 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001338 }
Victor Stinner8182b712010-07-28 00:40:58 +00001339 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1340 PyBuffer_Release((Py_buffer*)p);
1341 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1342 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001343 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001344 return converterr(
1345 "(cleanup problem)",
1346 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001347 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 break;
1349 }
1350
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001351 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001352 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001353
1354 }
1355
1356 *p_format = format;
1357 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001358
1359#undef FETCH_SIZE
1360#undef STORE_SIZE
1361#undef BUFFER_LEN
1362#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001363}
Guido van Rossumaa354651996-08-19 19:32:04 +00001364
Martin v. Löwis18e16552006-02-15 17:27:45 +00001365static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001366convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001367{
Victor Stinner5cb62392010-06-06 20:27:51 +00001368 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001369 Py_ssize_t count;
1370 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001371
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001372 *errmsg = NULL;
1373 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001374 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001375 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001376 return -1;
1377 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001378
Victor Stinner8182b712010-07-28 00:40:58 +00001379 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001381 count = view.len;
1382 *p = view.buf;
1383 PyBuffer_Release(&view);
1384 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001385}
Guido van Rossumaa354651996-08-19 19:32:04 +00001386
Martin v. Löwis423be952008-08-13 15:53:07 +00001387static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001388getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001389{
Victor Stinner8182b712010-07-28 00:40:58 +00001390 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001391 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001392 return -1;
1393 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001394 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001395 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001396 *errmsg = "contiguous buffer";
1397 return -1;
1398 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001399 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001400}
1401
Guido van Rossumaa354651996-08-19 19:32:04 +00001402/* Support for keyword arguments donated by
1403 Geoff Philbrick <philbric@delphi.hks.com> */
1404
Tim Petersf8cd3e82001-10-27 04:26:57 +00001405/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001406int
1407PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001408 PyObject *keywords,
1409 const char *format,
1410 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001411{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001412 int retval;
1413 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001414
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001415 if ((args == NULL || !PyTuple_Check(args)) ||
1416 (keywords != NULL && !PyDict_Check(keywords)) ||
1417 format == NULL ||
1418 kwlist == NULL)
1419 {
1420 PyErr_BadInternalCall();
1421 return 0;
1422 }
Tim Peters45772cd2001-10-27 03:58:40 +00001423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 va_start(va, kwlist);
1425 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1426 va_end(va);
1427 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001428}
1429
Vinay Sajip0b60f642019-10-15 08:26:12 +01001430PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001431_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001432 PyObject *keywords,
1433 const char *format,
1434 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 int retval;
1437 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001438
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001439 if ((args == NULL || !PyTuple_Check(args)) ||
1440 (keywords != NULL && !PyDict_Check(keywords)) ||
1441 format == NULL ||
1442 kwlist == NULL)
1443 {
1444 PyErr_BadInternalCall();
1445 return 0;
1446 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001447
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 va_start(va, kwlist);
1449 retval = vgetargskeywords(args, keywords, format,
1450 kwlist, &va, FLAG_SIZE_T);
1451 va_end(va);
1452 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001453}
1454
1455
Brett Cannon711e7d92004-07-10 22:20:32 +00001456int
1457PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001458 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001459 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001460 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001461{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001462 int retval;
1463 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001464
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001465 if ((args == NULL || !PyTuple_Check(args)) ||
1466 (keywords != NULL && !PyDict_Check(keywords)) ||
1467 format == NULL ||
1468 kwlist == NULL)
1469 {
1470 PyErr_BadInternalCall();
1471 return 0;
1472 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001473
Benjamin Peterson0c212142016-09-20 20:39:33 -07001474 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001475
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001476 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001477 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001479}
1480
Vinay Sajip0b60f642019-10-15 08:26:12 +01001481PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001482_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 PyObject *keywords,
1484 const char *format,
1485 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001486{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001487 int retval;
1488 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001489
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001490 if ((args == NULL || !PyTuple_Check(args)) ||
1491 (keywords != NULL && !PyDict_Check(keywords)) ||
1492 format == NULL ||
1493 kwlist == NULL)
1494 {
1495 PyErr_BadInternalCall();
1496 return 0;
1497 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001498
Benjamin Peterson0c212142016-09-20 20:39:33 -07001499 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001500
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 retval = vgetargskeywords(args, keywords, format,
1502 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001503 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001504 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001505}
1506
Vinay Sajip0b60f642019-10-15 08:26:12 +01001507PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001508_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1509 struct _PyArg_Parser *parser, ...)
1510{
1511 int retval;
1512 va_list va;
1513
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001514 va_start(va, parser);
1515 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1516 va_end(va);
1517 return retval;
1518}
1519
Vinay Sajip0b60f642019-10-15 08:26:12 +01001520PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001521_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1522 struct _PyArg_Parser *parser, ...)
1523{
1524 int retval;
1525 va_list va;
1526
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001527 va_start(va, parser);
1528 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1529 va_end(va);
1530 return retval;
1531}
1532
Vinay Sajip0b60f642019-10-15 08:26:12 +01001533PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001534_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001535 struct _PyArg_Parser *parser, ...)
1536{
1537 int retval;
1538 va_list va;
1539
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001540 va_start(va, parser);
1541 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1542 va_end(va);
1543 return retval;
1544}
1545
Vinay Sajip0b60f642019-10-15 08:26:12 +01001546PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001547_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001548 struct _PyArg_Parser *parser, ...)
1549{
1550 int retval;
1551 va_list va;
1552
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001553 va_start(va, parser);
1554 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1555 va_end(va);
1556 return retval;
1557}
1558
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001559
Vinay Sajip0b60f642019-10-15 08:26:12 +01001560PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001561_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1562 struct _PyArg_Parser *parser, va_list va)
1563{
1564 int retval;
1565 va_list lva;
1566
Benjamin Peterson0c212142016-09-20 20:39:33 -07001567 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001568
1569 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001570 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001571 return retval;
1572}
1573
Vinay Sajip0b60f642019-10-15 08:26:12 +01001574PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001575_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1576 struct _PyArg_Parser *parser, va_list va)
1577{
1578 int retval;
1579 va_list lva;
1580
Benjamin Peterson0c212142016-09-20 20:39:33 -07001581 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001582
1583 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001584 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001585 return retval;
1586}
1587
1588int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001589PyArg_ValidateKeywordArguments(PyObject *kwargs)
1590{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001591 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 PyErr_BadInternalCall();
1593 return 0;
1594 }
1595 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1596 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001597 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001598 return 0;
1599 }
1600 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001601}
1602
Christian Heimes380f7f22008-02-28 11:19:05 +00001603#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001604
Guido van Rossumaa354651996-08-19 19:32:04 +00001605static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001606vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001607 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001608{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001609 char msgbuf[512];
1610 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001611 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001613 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001614 int i, pos, len;
1615 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001616 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001617 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001618 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001619 freelist_t freelist;
1620
1621 freelist.entries = static_entries;
1622 freelist.first_available = 0;
1623 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001624
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001625 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001626 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 assert(format != NULL);
1628 assert(kwlist != NULL);
1629 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001631 /* grab the function name or custom error msg first (mutually exclusive) */
1632 fname = strchr(format, ':');
1633 if (fname) {
1634 fname++;
1635 custom_msg = NULL;
1636 }
1637 else {
1638 custom_msg = strchr(format,';');
1639 if (custom_msg)
1640 custom_msg++;
1641 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001642
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001643 /* scan kwlist and count the number of positional-only parameters */
1644 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1645 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001646 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001647 for (len = pos; kwlist[len]; len++) {
1648 if (!*kwlist[len]) {
1649 PyErr_SetString(PyExc_SystemError,
1650 "Empty keyword parameter name");
1651 return cleanreturn(0, &freelist);
1652 }
1653 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001654
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001655 if (len > STATIC_FREELIST_ENTRIES) {
1656 freelist.entries = PyMem_NEW(freelistentry_t, len);
1657 if (freelist.entries == NULL) {
1658 PyErr_NoMemory();
1659 return 0;
1660 }
1661 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001662 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001663
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001665 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1666 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001667 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1668 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001669 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001670 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001671 (fname == NULL) ? "function" : fname,
1672 (fname == NULL) ? "" : "()",
1673 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001674 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001676 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001677 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001678 }
Tim Petersc2f01122001-10-27 07:25:06 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1681 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001682 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001683 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001684 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001685 "Invalid format string (| specified twice)");
1686 return cleanreturn(0, &freelist);
1687 }
1688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 min = i;
1690 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001691
1692 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001693 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001694 "Invalid format string ($ before |)");
1695 return cleanreturn(0, &freelist);
1696 }
1697 }
1698 if (*format == '$') {
1699 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001700 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001701 "Invalid format string ($ specified twice)");
1702 return cleanreturn(0, &freelist);
1703 }
1704
1705 max = i;
1706 format++;
1707
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001708 if (max < pos) {
1709 PyErr_SetString(PyExc_SystemError,
1710 "Empty parameter name after $");
1711 return cleanreturn(0, &freelist);
1712 }
1713 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001714 /* Now we know the minimal and the maximal numbers of
1715 * positional arguments and can raise an exception with
1716 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001717 break;
1718 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001719 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001720 if (max == 0) {
1721 PyErr_Format(PyExc_TypeError,
1722 "%.200s%s takes no positional arguments",
1723 (fname == NULL) ? "function" : fname,
1724 (fname == NULL) ? "" : "()");
1725 }
1726 else {
1727 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301728 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001729 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001730 (fname == NULL) ? "function" : fname,
1731 (fname == NULL) ? "" : "()",
1732 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301733 max,
1734 max == 1 ? "" : "s",
1735 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001736 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001737 return cleanreturn(0, &freelist);
1738 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001739 }
1740 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001741 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 "More keyword list entries (%d) than "
1743 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001744 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001746 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001747 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001748 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001749 }
1750 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001751 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1752 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001753 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001754 }
1755 else if (PyErr_Occurred()) {
1756 return cleanreturn(0, &freelist);
1757 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001758 }
1759 else {
1760 current_arg = NULL;
1761 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001762
1763 if (current_arg) {
1764 msg = convertitem(current_arg, &format, p_va, flags,
1765 levels, msgbuf, sizeof(msgbuf), &freelist);
1766 if (msg) {
1767 seterror(i+1, msg, levels, fname, custom_msg);
1768 return cleanreturn(0, &freelist);
1769 }
1770 continue;
1771 }
1772
1773 if (i < min) {
1774 if (i < pos) {
1775 assert (min == INT_MAX);
1776 assert (max == INT_MAX);
1777 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001778 /* At that moment we still don't know the minimal and
1779 * the maximal numbers of positional arguments. Raising
1780 * an exception is deferred until we encounter | and $
1781 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001782 }
1783 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001784 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1785 "argument '%s' (pos %d)",
1786 (fname == NULL) ? "function" : fname,
1787 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001788 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001789 return cleanreturn(0, &freelist);
1790 }
1791 }
1792 /* current code reports success when all required args
1793 * fulfilled and no keyword args left, with no further
1794 * validation. XXX Maybe skip this in debug build ?
1795 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001796 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001797 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001798 }
1799 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001800
Leo Ariasc3d95082018-02-03 18:36:10 -06001801 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001802 * keyword args */
1803 msg = skipitem(&format, p_va, flags);
1804 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001805 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001806 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001807 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001808 }
1809 }
Tim Petersb054be42001-10-27 05:07:41 +00001810
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001811 if (skip) {
1812 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301813 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001814 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001815 (fname == NULL) ? "function" : fname,
1816 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001817 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301818 Py_MIN(pos, min),
1819 Py_MIN(pos, min) == 1 ? "" : "s",
1820 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001821 return cleanreturn(0, &freelist);
1822 }
1823
Larry Hastings83a9f482012-03-20 20:06:16 +00001824 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001825 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001826 "more argument specifiers than keyword list entries "
1827 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001828 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 }
Tim Petersc2f01122001-10-27 07:25:06 +00001830
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001831 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001832 PyObject *key;
1833 Py_ssize_t j;
1834 /* make sure there are no arguments given by name and position */
1835 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001836 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001837 if (current_arg) {
1838 /* arg present in tuple and in dict */
1839 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001840 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001841 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001842 (fname == NULL) ? "function" : fname,
1843 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001844 kwlist[i], i+1);
1845 return cleanreturn(0, &freelist);
1846 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001847 else if (PyErr_Occurred()) {
1848 return cleanreturn(0, &freelist);
1849 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001850 }
1851 /* make sure there are no extraneous keyword arguments */
1852 j = 0;
1853 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001854 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 if (!PyUnicode_Check(key)) {
1856 PyErr_SetString(PyExc_TypeError,
1857 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001858 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001860 for (i = pos; i < len; i++) {
1861 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001862 match = 1;
1863 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 }
1865 }
1866 if (!match) {
1867 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001868 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001869 "argument for %.200s%s",
1870 key,
1871 (fname == NULL) ? "this function" : fname,
1872 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001873 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001874 }
1875 }
1876 }
1877
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001878 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001879}
1880
1881
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001882/* List of static parsers. */
1883static struct _PyArg_Parser *static_arg_parsers = NULL;
1884
1885static int
1886parser_init(struct _PyArg_Parser *parser)
1887{
1888 const char * const *keywords;
1889 const char *format, *msg;
1890 int i, len, min, max, nkw;
1891 PyObject *kwtuple;
1892
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001893 assert(parser->keywords != NULL);
1894 if (parser->kwtuple != NULL) {
1895 return 1;
1896 }
1897
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001898 keywords = parser->keywords;
1899 /* scan keywords and count the number of positional-only parameters */
1900 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1901 }
1902 parser->pos = i;
1903 /* scan keywords and get greatest possible nbr of args */
1904 for (; keywords[i]; i++) {
1905 if (!*keywords[i]) {
1906 PyErr_SetString(PyExc_SystemError,
1907 "Empty keyword parameter name");
1908 return 0;
1909 }
1910 }
1911 len = i;
1912
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001913 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001914 if (format) {
1915 /* grab the function name or custom error msg first (mutually exclusive) */
1916 parser->fname = strchr(parser->format, ':');
1917 if (parser->fname) {
1918 parser->fname++;
1919 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001920 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001921 else {
1922 parser->custom_msg = strchr(parser->format,';');
1923 if (parser->custom_msg)
1924 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001925 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001926
1927 min = max = INT_MAX;
1928 for (i = 0; i < len; i++) {
1929 if (*format == '|') {
1930 if (min != INT_MAX) {
1931 PyErr_SetString(PyExc_SystemError,
1932 "Invalid format string (| specified twice)");
1933 return 0;
1934 }
1935 if (max != INT_MAX) {
1936 PyErr_SetString(PyExc_SystemError,
1937 "Invalid format string ($ before |)");
1938 return 0;
1939 }
1940 min = i;
1941 format++;
1942 }
1943 if (*format == '$') {
1944 if (max != INT_MAX) {
1945 PyErr_SetString(PyExc_SystemError,
1946 "Invalid format string ($ specified twice)");
1947 return 0;
1948 }
1949 if (i < parser->pos) {
1950 PyErr_SetString(PyExc_SystemError,
1951 "Empty parameter name after $");
1952 return 0;
1953 }
1954 max = i;
1955 format++;
1956 }
1957 if (IS_END_OF_FORMAT(*format)) {
1958 PyErr_Format(PyExc_SystemError,
1959 "More keyword list entries (%d) than "
1960 "format specifiers (%d)", len, i);
1961 return 0;
1962 }
1963
1964 msg = skipitem(&format, NULL, 0);
1965 if (msg) {
1966 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1967 format);
1968 return 0;
1969 }
1970 }
1971 parser->min = Py_MIN(min, len);
1972 parser->max = Py_MIN(max, len);
1973
1974 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001975 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02001976 "more argument specifiers than keyword list entries "
1977 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001978 return 0;
1979 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001980 }
1981
1982 nkw = len - parser->pos;
1983 kwtuple = PyTuple_New(nkw);
1984 if (kwtuple == NULL) {
1985 return 0;
1986 }
1987 keywords = parser->keywords + parser->pos;
1988 for (i = 0; i < nkw; i++) {
1989 PyObject *str = PyUnicode_FromString(keywords[i]);
1990 if (str == NULL) {
1991 Py_DECREF(kwtuple);
1992 return 0;
1993 }
1994 PyUnicode_InternInPlace(&str);
1995 PyTuple_SET_ITEM(kwtuple, i, str);
1996 }
1997 parser->kwtuple = kwtuple;
1998
1999 assert(parser->next == NULL);
2000 parser->next = static_arg_parsers;
2001 static_arg_parsers = parser;
2002 return 1;
2003}
2004
2005static void
2006parser_clear(struct _PyArg_Parser *parser)
2007{
2008 Py_CLEAR(parser->kwtuple);
2009}
2010
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002011static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002012find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002013{
2014 Py_ssize_t i, nkwargs;
2015
2016 nkwargs = PyTuple_GET_SIZE(kwnames);
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002017 for (i = 0; i < nkwargs; i++) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002018 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
2019
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002020 /* kwname == key will normally find a match in since keyword keys
2021 should be interned strings; if not retry below in a new loop. */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002022 if (kwname == key) {
2023 return kwstack[i];
2024 }
Sebastian Berg75bb07e2019-12-18 00:51:22 -06002025 }
2026
2027 for (i = 0; i < nkwargs; i++) {
2028 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
Jeroen Demeyer05677862019-08-16 12:41:27 +02002029 assert(PyUnicode_Check(kwname));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002030 if (_PyUnicode_EQ(kwname, key)) {
2031 return kwstack[i];
2032 }
2033 }
2034 return NULL;
2035}
2036
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002037static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002038vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002039 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002040 struct _PyArg_Parser *parser,
2041 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002042{
2043 PyObject *kwtuple;
2044 char msgbuf[512];
2045 int levels[32];
2046 const char *format;
2047 const char *msg;
2048 PyObject *keyword;
2049 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002050 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002051 PyObject *current_arg;
2052 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2053 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002054 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002055
2056 freelist.entries = static_entries;
2057 freelist.first_available = 0;
2058 freelist.entries_malloced = 0;
2059
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002060 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002061 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002062 assert(p_va != NULL);
2063
Victor Stinner80ab22f2017-01-16 23:16:47 +01002064 if (parser == NULL) {
2065 PyErr_BadInternalCall();
2066 return 0;
2067 }
2068
2069 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2070 PyErr_BadInternalCall();
2071 return 0;
2072 }
2073
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002074 if (!parser_init(parser)) {
2075 return 0;
2076 }
2077
2078 kwtuple = parser->kwtuple;
2079 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002080 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002081
2082 if (len > STATIC_FREELIST_ENTRIES) {
2083 freelist.entries = PyMem_NEW(freelistentry_t, len);
2084 if (freelist.entries == NULL) {
2085 PyErr_NoMemory();
2086 return 0;
2087 }
2088 freelist.entries_malloced = 1;
2089 }
2090
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002091 if (kwargs != NULL) {
2092 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002093 }
2094 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002095 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002096 kwstack = args + nargs;
2097 }
2098 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002099 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002100 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002101 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002102 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2103 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002104 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002105 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002106 (parser->fname == NULL) ? "function" : parser->fname,
2107 (parser->fname == NULL) ? "" : "()",
2108 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002109 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002110 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002111 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002112 return cleanreturn(0, &freelist);
2113 }
2114 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002115 if (parser->max == 0) {
2116 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002117 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002118 (parser->fname == NULL) ? "function" : parser->fname,
2119 (parser->fname == NULL) ? "" : "()");
2120 }
2121 else {
2122 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002123 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002124 (parser->fname == NULL) ? "function" : parser->fname,
2125 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002126 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302127 parser->max,
2128 parser->max == 1 ? "" : "s",
2129 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002130 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002131 return cleanreturn(0, &freelist);
2132 }
2133
2134 format = parser->format;
2135 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2136 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002137 if (*format == '|') {
2138 format++;
2139 }
2140 if (*format == '$') {
2141 format++;
2142 }
2143 assert(!IS_END_OF_FORMAT(*format));
2144
Serhiy Storchaka17414412017-01-17 10:07:25 +02002145 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002146 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002147 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002148 else if (nkwargs && i >= pos) {
2149 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002150 if (kwargs != NULL) {
2151 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2152 if (!current_arg && PyErr_Occurred()) {
2153 return cleanreturn(0, &freelist);
2154 }
2155 }
2156 else {
2157 current_arg = find_keyword(kwnames, kwstack, keyword);
2158 }
2159 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002160 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002161 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002162 }
2163 else {
2164 current_arg = NULL;
2165 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002166
2167 if (current_arg) {
2168 msg = convertitem(current_arg, &format, p_va, flags,
2169 levels, msgbuf, sizeof(msgbuf), &freelist);
2170 if (msg) {
2171 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2172 return cleanreturn(0, &freelist);
2173 }
2174 continue;
2175 }
2176
2177 if (i < parser->min) {
2178 /* Less arguments than required */
2179 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002180 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002181 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302182 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002183 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002184 (parser->fname == NULL) ? "function" : parser->fname,
2185 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002186 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302187 min,
2188 min == 1 ? "" : "s",
2189 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002190 }
2191 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002192 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002193 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2194 "argument '%U' (pos %d)",
2195 (parser->fname == NULL) ? "function" : parser->fname,
2196 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002197 keyword, i+1);
2198 }
2199 return cleanreturn(0, &freelist);
2200 }
2201 /* current code reports success when all required args
2202 * fulfilled and no keyword args left, with no further
2203 * validation. XXX Maybe skip this in debug build ?
2204 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002205 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002206 return cleanreturn(1, &freelist);
2207 }
2208
Leo Ariasc3d95082018-02-03 18:36:10 -06002209 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002210 * keyword args */
2211 msg = skipitem(&format, p_va, flags);
2212 assert(msg == NULL);
2213 }
2214
2215 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2216
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002217 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002218 Py_ssize_t j;
2219 /* make sure there are no arguments given by name and position */
2220 for (i = pos; i < nargs; i++) {
2221 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002222 if (kwargs != NULL) {
2223 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2224 if (!current_arg && PyErr_Occurred()) {
2225 return cleanreturn(0, &freelist);
2226 }
2227 }
2228 else {
2229 current_arg = find_keyword(kwnames, kwstack, keyword);
2230 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002231 if (current_arg) {
2232 /* arg present in tuple and in dict */
2233 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002234 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002235 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002236 (parser->fname == NULL) ? "function" : parser->fname,
2237 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002238 keyword, i+1);
2239 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002240 }
2241 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002242 /* make sure there are no extraneous keyword arguments */
2243 j = 0;
2244 while (1) {
2245 int match;
2246 if (kwargs != NULL) {
2247 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2248 break;
2249 }
2250 else {
2251 if (j >= PyTuple_GET_SIZE(kwnames))
2252 break;
2253 keyword = PyTuple_GET_ITEM(kwnames, j);
2254 j++;
2255 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002256
Serhiy Storchaka17414412017-01-17 10:07:25 +02002257 match = PySequence_Contains(kwtuple, keyword);
2258 if (match <= 0) {
2259 if (!match) {
2260 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002261 "'%S' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002262 "argument for %.200s%s",
2263 keyword,
2264 (parser->fname == NULL) ? "this function" : parser->fname,
2265 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002266 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002267 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002268 }
2269 }
2270 }
2271
2272 return cleanreturn(1, &freelist);
2273}
2274
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002275static int
2276vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2277 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2278{
2279 PyObject **stack;
2280 Py_ssize_t nargs;
2281
Victor Stinner80ab22f2017-01-16 23:16:47 +01002282 if (args == NULL
2283 || !PyTuple_Check(args)
2284 || (keywords != NULL && !PyDict_Check(keywords)))
2285 {
2286 PyErr_BadInternalCall();
2287 return 0;
2288 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002289
Victor Stinnerd17a6932018-11-09 16:56:48 +01002290 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002291 nargs = PyTuple_GET_SIZE(args);
2292 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2293 parser, p_va, flags);
2294}
2295
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002296
Serhiy Storchaka31913912019-03-14 10:32:22 +02002297#undef _PyArg_UnpackKeywords
2298
2299PyObject * const *
2300_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2301 PyObject *kwargs, PyObject *kwnames,
2302 struct _PyArg_Parser *parser,
2303 int minpos, int maxpos, int minkw,
2304 PyObject **buf)
2305{
2306 PyObject *kwtuple;
2307 PyObject *keyword;
2308 int i, posonly, minposonly, maxargs;
2309 int reqlimit = minkw ? maxpos + minkw : minpos;
2310 Py_ssize_t nkwargs;
2311 PyObject *current_arg;
2312 PyObject * const *kwstack = NULL;
2313
2314 assert(kwargs == NULL || PyDict_Check(kwargs));
2315 assert(kwargs == NULL || kwnames == NULL);
2316
2317 if (parser == NULL) {
2318 PyErr_BadInternalCall();
2319 return NULL;
2320 }
2321
2322 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2323 PyErr_BadInternalCall();
2324 return NULL;
2325 }
2326
2327 if (args == NULL && nargs == 0) {
2328 args = buf;
2329 }
2330
2331 if (!parser_init(parser)) {
2332 return NULL;
2333 }
2334
2335 kwtuple = parser->kwtuple;
2336 posonly = parser->pos;
2337 minposonly = Py_MIN(posonly, minpos);
2338 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2339
2340 if (kwargs != NULL) {
2341 nkwargs = PyDict_GET_SIZE(kwargs);
2342 }
2343 else if (kwnames != NULL) {
2344 nkwargs = PyTuple_GET_SIZE(kwnames);
2345 kwstack = args + nargs;
2346 }
2347 else {
2348 nkwargs = 0;
2349 }
2350 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2351 /* Fast path. */
2352 return args;
2353 }
2354 if (nargs + nkwargs > maxargs) {
2355 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2356 messages in some special cases (see bpo-31229). */
2357 PyErr_Format(PyExc_TypeError,
2358 "%.200s%s takes at most %d %sargument%s (%zd given)",
2359 (parser->fname == NULL) ? "function" : parser->fname,
2360 (parser->fname == NULL) ? "" : "()",
2361 maxargs,
2362 (nargs == 0) ? "keyword " : "",
2363 (maxargs == 1) ? "" : "s",
2364 nargs + nkwargs);
2365 return NULL;
2366 }
2367 if (nargs > maxpos) {
2368 if (maxpos == 0) {
2369 PyErr_Format(PyExc_TypeError,
2370 "%.200s%s takes no positional arguments",
2371 (parser->fname == NULL) ? "function" : parser->fname,
2372 (parser->fname == NULL) ? "" : "()");
2373 }
2374 else {
2375 PyErr_Format(PyExc_TypeError,
2376 "%.200s%s takes %s %d positional argument%s (%zd given)",
2377 (parser->fname == NULL) ? "function" : parser->fname,
2378 (parser->fname == NULL) ? "" : "()",
2379 (minpos < maxpos) ? "at most" : "exactly",
2380 maxpos,
2381 (maxpos == 1) ? "" : "s",
2382 nargs);
2383 }
2384 return NULL;
2385 }
2386 if (nargs < minposonly) {
2387 PyErr_Format(PyExc_TypeError,
2388 "%.200s%s takes %s %d positional argument%s"
2389 " (%zd given)",
2390 (parser->fname == NULL) ? "function" : parser->fname,
2391 (parser->fname == NULL) ? "" : "()",
2392 minposonly < maxpos ? "at least" : "exactly",
2393 minposonly,
2394 minposonly == 1 ? "" : "s",
2395 nargs);
2396 return NULL;
2397 }
2398
2399 /* copy tuple args */
2400 for (i = 0; i < nargs; i++) {
2401 buf[i] = args[i];
2402 }
2403
2404 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002405 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002406 if (nkwargs) {
2407 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2408 if (kwargs != NULL) {
2409 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2410 if (!current_arg && PyErr_Occurred()) {
2411 return NULL;
2412 }
2413 }
2414 else {
2415 current_arg = find_keyword(kwnames, kwstack, keyword);
2416 }
2417 }
2418 else if (i >= reqlimit) {
2419 break;
2420 }
2421 else {
2422 current_arg = NULL;
2423 }
2424
2425 buf[i] = current_arg;
2426
2427 if (current_arg) {
2428 --nkwargs;
2429 }
2430 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2431 /* Less arguments than required */
2432 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2433 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2434 "argument '%U' (pos %d)",
2435 (parser->fname == NULL) ? "function" : parser->fname,
2436 (parser->fname == NULL) ? "" : "()",
2437 keyword, i+1);
2438 return NULL;
2439 }
2440 }
2441
2442 if (nkwargs > 0) {
2443 Py_ssize_t j;
2444 /* make sure there are no arguments given by name and position */
2445 for (i = posonly; i < nargs; i++) {
2446 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2447 if (kwargs != NULL) {
2448 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2449 if (!current_arg && PyErr_Occurred()) {
2450 return NULL;
2451 }
2452 }
2453 else {
2454 current_arg = find_keyword(kwnames, kwstack, keyword);
2455 }
2456 if (current_arg) {
2457 /* arg present in tuple and in dict */
2458 PyErr_Format(PyExc_TypeError,
2459 "argument for %.200s%s given by name ('%U') "
2460 "and position (%d)",
2461 (parser->fname == NULL) ? "function" : parser->fname,
2462 (parser->fname == NULL) ? "" : "()",
2463 keyword, i+1);
2464 return NULL;
2465 }
2466 }
2467 /* make sure there are no extraneous keyword arguments */
2468 j = 0;
2469 while (1) {
2470 int match;
2471 if (kwargs != NULL) {
2472 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2473 break;
2474 }
2475 else {
2476 if (j >= PyTuple_GET_SIZE(kwnames))
2477 break;
2478 keyword = PyTuple_GET_ITEM(kwnames, j);
2479 j++;
2480 }
2481
Serhiy Storchaka31913912019-03-14 10:32:22 +02002482 match = PySequence_Contains(kwtuple, keyword);
2483 if (match <= 0) {
2484 if (!match) {
2485 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002486 "'%S' is an invalid keyword "
Serhiy Storchaka31913912019-03-14 10:32:22 +02002487 "argument for %.200s%s",
2488 keyword,
2489 (parser->fname == NULL) ? "this function" : parser->fname,
2490 (parser->fname == NULL) ? "" : "()");
2491 }
2492 return NULL;
2493 }
2494 }
2495 }
2496
2497 return buf;
2498}
2499
2500
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002501static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002502skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002503{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 const char *format = *p_format;
2505 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002506
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002507 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002508
Larry Hastingsa3479012012-05-08 23:52:03 -07002509 /*
2510 * codes that take a single data pointer as an argument
2511 * (the type of the pointer is irrelevant)
2512 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002513
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002514 case 'b': /* byte -- very short int */
2515 case 'B': /* byte as bitfield */
2516 case 'h': /* short int */
2517 case 'H': /* short int as bitfield */
2518 case 'i': /* int */
2519 case 'I': /* int sized bitfield */
2520 case 'l': /* long int */
2521 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002522 case 'L': /* long long */
2523 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002524 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 case 'f': /* float */
2526 case 'd': /* double */
2527 case 'D': /* complex double */
2528 case 'c': /* char */
2529 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002530 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002531 case 'S': /* string object */
2532 case 'Y': /* string object */
2533 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002534 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002535 if (p_va != NULL) {
2536 (void) va_arg(*p_va, void *);
2537 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002538 break;
2539 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002542
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 case 'e': /* string with encoding */
2544 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002545 if (p_va != NULL) {
2546 (void) va_arg(*p_va, const char *);
2547 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002548 if (!(*format == 's' || *format == 't'))
2549 /* after 'e', only 's' and 't' is allowed */
2550 goto err;
2551 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 }
Stefan Krahf432a322017-08-21 13:09:59 +02002553 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002554
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 case 's': /* string */
2556 case 'z': /* string or None */
2557 case 'y': /* bytes */
2558 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002559 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 case 'w': /* buffer, read-write */
2561 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002562 if (p_va != NULL) {
2563 (void) va_arg(*p_va, char **);
2564 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002565 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002566 if (p_va != NULL) {
2567 if (flags & FLAG_SIZE_T)
2568 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002569 else {
2570 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2571 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2572 return NULL;
2573 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002574 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002575 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002576 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002577 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002578 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2579 && *format == '*')
2580 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002581 format++;
2582 }
2583 break;
2584 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002585
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002586 case 'O': /* object */
2587 {
2588 if (*format == '!') {
2589 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002590 if (p_va != NULL) {
2591 (void) va_arg(*p_va, PyTypeObject*);
2592 (void) va_arg(*p_va, PyObject **);
2593 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002594 }
2595 else if (*format == '&') {
2596 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002597 if (p_va != NULL) {
2598 (void) va_arg(*p_va, converter);
2599 (void) va_arg(*p_va, void *);
2600 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002601 format++;
2602 }
2603 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002604 if (p_va != NULL) {
2605 (void) va_arg(*p_va, PyObject **);
2606 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002607 }
2608 break;
2609 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002610
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002611 case '(': /* bypass tuple, not handled at all previously */
2612 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002613 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002614 for (;;) {
2615 if (*format==')')
2616 break;
2617 if (IS_END_OF_FORMAT(*format))
2618 return "Unmatched left paren in format "
2619 "string";
2620 msg = skipitem(&format, p_va, flags);
2621 if (msg)
2622 return msg;
2623 }
2624 format++;
2625 break;
2626 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002627
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 case ')':
2629 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002630
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002631 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002632err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002633 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002634
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002635 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002636
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002637 *p_format = format;
2638 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002639}
Fred Drakee4616e62001-10-23 21:09:29 +00002640
2641
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002642#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002643
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002644int
2645_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2646 Py_ssize_t min, Py_ssize_t max)
2647{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002648 assert(min >= 0);
2649 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002650
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002651 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002652 if (name != NULL)
2653 PyErr_Format(
2654 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302655 "%.200s expected %s%zd argument%s, got %zd",
2656 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002657 else
2658 PyErr_Format(
2659 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302660 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002661 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302662 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002663 return 0;
2664 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002665
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002666 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002667 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002668 }
2669
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002670 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002671 if (name != NULL)
2672 PyErr_Format(
2673 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302674 "%.200s expected %s%zd argument%s, got %zd",
2675 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002676 else
2677 PyErr_Format(
2678 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302679 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002680 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302681 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002682 return 0;
2683 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002684
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002685 return 1;
2686}
2687
2688static int
2689unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2690 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2691{
2692 Py_ssize_t i;
2693 PyObject **o;
2694
2695 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2696 return 0;
2697 }
2698
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002699 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002700 o = va_arg(vargs, PyObject **);
2701 *o = args[i];
2702 }
2703 return 1;
2704}
2705
2706int
2707PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2708{
2709 PyObject **stack;
2710 Py_ssize_t nargs;
2711 int retval;
2712 va_list vargs;
2713
2714 if (!PyTuple_Check(args)) {
2715 PyErr_SetString(PyExc_SystemError,
2716 "PyArg_UnpackTuple() argument list is not a tuple");
2717 return 0;
2718 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002719 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002720 nargs = PyTuple_GET_SIZE(args);
2721
Raymond Hettinger94230232016-03-26 03:02:48 -07002722#ifdef HAVE_STDARG_PROTOTYPES
2723 va_start(vargs, max);
2724#else
2725 va_start(vargs);
2726#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002727 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002729 return retval;
2730}
2731
2732int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002733_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002734 Py_ssize_t min, Py_ssize_t max, ...)
2735{
2736 int retval;
2737 va_list vargs;
2738
2739#ifdef HAVE_STDARG_PROTOTYPES
2740 va_start(vargs, max);
2741#else
2742 va_start(vargs);
2743#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002744 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002745 va_end(vargs);
2746 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002747}
Georg Brandl02c42872005-08-26 06:42:30 +00002748
2749
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002750#undef _PyArg_NoKeywords
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002751#undef _PyArg_NoKwnames
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002752#undef _PyArg_NoPositional
2753
Georg Brandl02c42872005-08-26 06:42:30 +00002754/* For type constructors that don't take keyword args
2755 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002756 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002757 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002758 */
2759int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002760_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002761{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002762 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002764 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002765 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002766 PyErr_BadInternalCall();
2767 return 0;
2768 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002769 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002770 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002771 }
2772
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002773 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002774 funcname);
2775 return 0;
2776}
2777
Victor Stinner29d39cc2017-01-17 01:40:01 +01002778int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002779_PyArg_NoPositional(const char *funcname, PyObject *args)
2780{
2781 if (args == NULL)
2782 return 1;
2783 if (!PyTuple_CheckExact(args)) {
2784 PyErr_BadInternalCall();
2785 return 0;
2786 }
2787 if (PyTuple_GET_SIZE(args) == 0)
2788 return 1;
2789
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002790 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002791 funcname);
2792 return 0;
2793}
2794
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002795int
2796_PyArg_NoKwnames(const char *funcname, PyObject *kwnames)
2797{
2798 if (kwnames == NULL) {
2799 return 1;
2800 }
2801
2802 assert(PyTuple_CheckExact(kwnames));
2803
2804 if (PyTuple_GET_SIZE(kwnames) == 0) {
2805 return 1;
2806 }
2807
2808 PyErr_Format(PyExc_TypeError, "%s() takes no keyword arguments", funcname);
2809 return 0;
2810}
2811
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002812void
2813_PyArg_Fini(void)
2814{
2815 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2816 while (s) {
2817 tmp = s->next;
2818 s->next = NULL;
2819 parser_clear(s);
2820 s = tmp;
2821 }
2822 static_arg_parsers = NULL;
2823}
2824
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002825#ifdef __cplusplus
2826};
2827#endif