blob: 8839492e5ef41a5e77c96b8f7e758a247e0d7a5a [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 Stinner384621c2020-06-22 17:27:35 +02005#include "pycore_tuple.h" // _PyTuple_ITEMS()
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) {
Victor Stinner00d7abd2020-12-01 09:56:42 +0100205 PyMem_Free(ptr);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000206 }
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)
Victor Stinner00d7abd2020-12-01 09:56:42 +0100249 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 */
Victor Stinner37bb2892020-06-19 11:45:31 +0200659#define REQUIRE_PY_SSIZE_T_CLEAN \
660 if (!(flags & FLAG_SIZE_T)) { \
661 PyErr_SetString(PyExc_SystemError, \
662 "PY_SSIZE_T_CLEAN macro must be defined for '#' formats"); \
663 return NULL; \
Inada Naokid3c72a22019-03-23 21:04:40 +0900664 }
Victor Stinner6ab8e822011-01-04 11:16:49 +0000665#define RETURN_ERR_OCCURRED return msgbuf
Martin v. Löwis18e16552006-02-15 17:27:45 +0000666
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000667 const char *format = *p_format;
668 char c = *format++;
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200669 const char *sarg;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000670
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000671 switch (c) {
Guido van Rossum98297ee2007-11-06 21:34:58 +0000672
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000673 case 'b': { /* unsigned byte -- very short int */
674 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300675 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000676 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000677 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000678 else if (ival < 0) {
679 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000680 "unsigned byte integer is less than minimum");
681 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000682 }
683 else if (ival > UCHAR_MAX) {
684 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000685 "unsigned byte integer is greater than maximum");
686 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000687 }
688 else
689 *p = (unsigned char) ival;
690 break;
691 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000692
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000693 case 'B': {/* byte sized bitfield - both signed and unsigned
694 values allowed */
695 char *p = va_arg(*p_va, char *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300696 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
697 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000698 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000699 else
700 *p = (unsigned char) ival;
701 break;
702 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000704 case 'h': {/* signed short int */
705 short *p = va_arg(*p_va, short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300706 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000707 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000708 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000709 else if (ival < SHRT_MIN) {
710 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000711 "signed short integer is less than minimum");
712 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000713 }
714 else if (ival > SHRT_MAX) {
715 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000716 "signed short integer is greater than maximum");
717 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000718 }
719 else
720 *p = (short) ival;
721 break;
722 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000723
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000724 case 'H': { /* short int sized bitfield, both signed and
725 unsigned allowed */
726 unsigned short *p = va_arg(*p_va, unsigned short *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300727 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
728 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000729 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000730 else
731 *p = (unsigned short) ival;
732 break;
733 }
Martin v. Löwis18e16552006-02-15 17:27:45 +0000734
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000735 case 'i': {/* signed int */
736 int *p = va_arg(*p_va, int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300737 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000738 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000739 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000740 else if (ival > INT_MAX) {
741 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000742 "signed integer is greater than maximum");
743 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000744 }
745 else if (ival < INT_MIN) {
746 PyErr_SetString(PyExc_OverflowError,
Victor Stinner6ab8e822011-01-04 11:16:49 +0000747 "signed integer is less than minimum");
748 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000749 }
750 else
751 *p = ival;
752 break;
753 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +0000754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000755 case 'I': { /* int sized bitfield, both signed and
756 unsigned allowed */
757 unsigned int *p = va_arg(*p_va, unsigned int *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300758 unsigned long ival = PyLong_AsUnsignedLongMask(arg);
759 if (ival == (unsigned long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000760 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000761 else
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300762 *p = (unsigned int) ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000763 break;
764 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000765
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000766 case 'n': /* Py_ssize_t */
767 {
768 PyObject *iobj;
769 Py_ssize_t *p = va_arg(*p_va, Py_ssize_t *);
770 Py_ssize_t ival = -1;
Serhiy Storchaka5f4b229d2020-05-28 10:33:45 +0300771 iobj = _PyNumber_Index(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000772 if (iobj != NULL) {
773 ival = PyLong_AsSsize_t(iobj);
774 Py_DECREF(iobj);
775 }
776 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000777 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000778 *p = ival;
779 break;
780 }
781 case 'l': {/* long int */
782 long *p = va_arg(*p_va, long *);
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300783 long ival = PyLong_AsLong(arg);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000784 if (ival == -1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000785 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000786 else
787 *p = ival;
788 break;
789 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000790
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000791 case 'k': { /* long sized bitfield */
792 unsigned long *p = va_arg(*p_va, unsigned long *);
793 unsigned long ival;
794 if (PyLong_Check(arg))
795 ival = PyLong_AsUnsignedLongMask(arg);
796 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200797 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000798 *p = ival;
799 break;
800 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000801
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700802 case 'L': {/* long long */
803 long long *p = va_arg( *p_va, long long * );
Serhiy Storchaka578c3952020-05-26 18:43:38 +0300804 long long ival = PyLong_AsLongLong(arg);
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700805 if (ival == (long long)-1 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000806 RETURN_ERR_OCCURRED;
Mark Dickinsonc7301312010-06-10 16:05:10 +0000807 else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000808 *p = ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000809 break;
810 }
Thomas Hellera4ea6032003-04-17 18:55:45 +0000811
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000812 case 'K': { /* long long sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -0700813 unsigned long long *p = va_arg(*p_va, unsigned long long *);
814 unsigned long long ival;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000815 if (PyLong_Check(arg))
816 ival = PyLong_AsUnsignedLongLongMask(arg);
817 else
Serhiy Storchakac4b813d2016-02-08 01:06:11 +0200818 return converterr("int", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000819 *p = ival;
820 break;
821 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000822
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000823 case 'f': {/* float */
824 float *p = va_arg(*p_va, float *);
825 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700826 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000827 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000828 else
829 *p = (float) dval;
830 break;
831 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000832
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000833 case 'd': {/* double */
834 double *p = va_arg(*p_va, double *);
835 double dval = PyFloat_AsDouble(arg);
Raymond Hettingeraef9ad82019-08-24 19:10:39 -0700836 if (dval == -1.0 && PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000837 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000838 else
839 *p = dval;
840 break;
841 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000842
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000843 case 'D': {/* complex double */
844 Py_complex *p = va_arg(*p_va, Py_complex *);
845 Py_complex cval;
846 cval = PyComplex_AsCComplex(arg);
847 if (PyErr_Occurred())
Victor Stinner6ab8e822011-01-04 11:16:49 +0000848 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000849 else
850 *p = cval;
851 break;
852 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000853
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000854 case 'c': {/* char */
855 char *p = va_arg(*p_va, char *);
856 if (PyBytes_Check(arg) && PyBytes_Size(arg) == 1)
857 *p = PyBytes_AS_STRING(arg)[0];
Eli Bendersky906b88f2011-07-29 07:05:08 +0300858 else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1)
859 *p = PyByteArray_AS_STRING(arg)[0];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000860 else
861 return converterr("a byte string of length 1", arg, msgbuf, bufsize);
862 break;
863 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000864
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000865 case 'C': {/* unicode char */
866 int *p = va_arg(*p_va, int *);
Victor Stinnere1335c72011-10-04 20:53:03 +0200867 int kind;
Serhiy Storchakacd8295f2020-04-11 10:48:40 +0300868 const void *data;
Victor Stinnere1335c72011-10-04 20:53:03 +0200869
870 if (!PyUnicode_Check(arg))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000871 return converterr("a unicode character", arg, msgbuf, bufsize);
Victor Stinnere1335c72011-10-04 20:53:03 +0200872
873 if (PyUnicode_READY(arg))
874 RETURN_ERR_OCCURRED;
875
876 if (PyUnicode_GET_LENGTH(arg) != 1)
877 return converterr("a unicode character", arg, msgbuf, bufsize);
878
879 kind = PyUnicode_KIND(arg);
880 data = PyUnicode_DATA(arg);
881 *p = PyUnicode_READ(kind, data, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000882 break;
883 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000884
Larry Hastingsfaf91e72012-05-05 16:54:29 -0700885 case 'p': {/* boolean *p*redicate */
886 int *p = va_arg(*p_va, int *);
887 int val = PyObject_IsTrue(arg);
888 if (val > 0)
889 *p = 1;
890 else if (val == 0)
891 *p = 0;
892 else
893 RETURN_ERR_OCCURRED;
894 break;
895 }
896
Victor Stinner3dcb5ac2010-06-08 22:54:19 +0000897 /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000898 need to be cleaned up! */
Guido van Rossum98297ee2007-11-06 21:34:58 +0000899
Serhiy Storchakab757c832014-12-05 22:25:22 +0200900 case 'y': {/* any bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000901 void **p = (void **)va_arg(*p_va, char **);
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200902 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000903 Py_ssize_t count;
904 if (*format == '*') {
905 if (getbuffer(arg, (Py_buffer*)p, &buf) < 0)
906 return converterr(buf, arg, msgbuf, bufsize);
907 format++;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400908 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000909 return converterr(
910 "(cleanup problem)",
911 arg, msgbuf, bufsize);
912 }
913 break;
914 }
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200915 count = convertbuffer(arg, (const void **)p, &buf);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000916 if (count < 0)
917 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner06e49dd2010-06-13 18:21:50 +0000918 if (*format == '#') {
Victor Stinner37bb2892020-06-19 11:45:31 +0200919 REQUIRE_PY_SSIZE_T_CLEAN;
920 Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*);
921 *psize = count;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000922 format++;
Victor Stinner06e49dd2010-06-13 18:21:50 +0000923 } else {
Serhiy Storchakad8a14472014-09-06 20:07:17 +0300924 if (strlen(*p) != (size_t)count) {
925 PyErr_SetString(PyExc_ValueError, "embedded null byte");
926 RETURN_ERR_OCCURRED;
927 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000928 }
929 break;
930 }
Walter Dörwald612344f2007-05-04 19:28:21 +0000931
Serhiy Storchakab757c832014-12-05 22:25:22 +0200932 case 's': /* text string or bytes-like object */
933 case 'z': /* text string, bytes-like object or None */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000934 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000935 if (*format == '*') {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000936 /* "s*" or "z*" */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000937 Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *);
Martin v. Löwis423be952008-08-13 15:53:07 +0000938
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000939 if (c == 'z' && arg == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000940 PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0);
941 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200942 Py_ssize_t len;
943 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
944 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000945 return converterr(CONV_UNICODE,
946 arg, msgbuf, bufsize);
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200947 PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000948 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200949 else { /* any bytes-like object */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200950 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000951 if (getbuffer(arg, p, &buf) < 0)
952 return converterr(buf, arg, msgbuf, bufsize);
953 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -0400954 if (addcleanup(p, freelist, cleanup_buffer)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000955 return converterr(
956 "(cleanup problem)",
957 arg, msgbuf, bufsize);
958 }
959 format++;
Serhiy Storchakab757c832014-12-05 22:25:22 +0200960 } else if (*format == '#') { /* a string or read-only bytes-like object */
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000961 /* "s#" or "z#" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200962 const void **p = (const void **)va_arg(*p_va, const char **);
Victor Stinner37bb2892020-06-19 11:45:31 +0200963 REQUIRE_PY_SSIZE_T_CLEAN;
964 Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*);
Guido van Rossum98297ee2007-11-06 21:34:58 +0000965
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000966 if (c == 'z' && arg == Py_None) {
967 *p = NULL;
Victor Stinner37bb2892020-06-19 11:45:31 +0200968 *psize = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000969 }
970 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200971 Py_ssize_t len;
972 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
973 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000974 return converterr(CONV_UNICODE,
975 arg, msgbuf, bufsize);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200976 *p = sarg;
Victor Stinner37bb2892020-06-19 11:45:31 +0200977 *psize = len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000978 }
Serhiy Storchakab757c832014-12-05 22:25:22 +0200979 else { /* read-only bytes-like object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000980 /* XXX Really? */
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200981 const char *buf;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000982 Py_ssize_t count = convertbuffer(arg, p, &buf);
983 if (count < 0)
984 return converterr(buf, arg, msgbuf, bufsize);
Victor Stinner37bb2892020-06-19 11:45:31 +0200985 *psize = count;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000986 }
987 format++;
988 } else {
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000989 /* "s" or "z" */
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +0200990 const char **p = va_arg(*p_va, const char **);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200991 Py_ssize_t len;
992 sarg = NULL;
Guido van Rossum98297ee2007-11-06 21:34:58 +0000993
Victor Stinner3c9e6e92010-06-24 22:31:12 +0000994 if (c == 'z' && arg == Py_None)
995 *p = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000996 else if (PyUnicode_Check(arg)) {
Martin v. Löwisd63a3b82011-09-28 07:41:54 +0200997 sarg = PyUnicode_AsUTF8AndSize(arg, &len);
998 if (sarg == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000999 return converterr(CONV_UNICODE,
1000 arg, msgbuf, bufsize);
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001001 if (strlen(sarg) != (size_t)len) {
1002 PyErr_SetString(PyExc_ValueError, "embedded null character");
1003 RETURN_ERR_OCCURRED;
1004 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001005 *p = sarg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001006 }
1007 else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001008 return converterr(c == 'z' ? "str or None" : "str",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001009 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001010 }
1011 break;
1012 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001013
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001014 case 'u': /* raw unicode buffer (Py_UNICODE *) */
1015 case 'Z': /* raw unicode buffer or None */
1016 {
Inada Naoki2c4928d2020-06-17 20:09:44 +09001017 // TODO: Raise DeprecationWarning
1018_Py_COMP_DIAG_PUSH
1019_Py_COMP_DIAG_IGNORE_DEPR_DECLS
Brett Cannonb94767f2011-02-22 20:15:44 +00001020 Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **);
1021
Serhiy Storchakab757c832014-12-05 22:25:22 +02001022 if (*format == '#') {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001023 /* "u#" or "Z#" */
Victor Stinner37bb2892020-06-19 11:45:31 +02001024 REQUIRE_PY_SSIZE_T_CLEAN;
1025 Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*);
Travis E. Oliphantddacf962007-10-13 21:03:27 +00001026
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001027 if (c == 'Z' && arg == Py_None) {
1028 *p = NULL;
Victor Stinner37bb2892020-06-19 11:45:31 +02001029 *psize = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001030 }
1031 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001032 Py_ssize_t len;
1033 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001034 if (*p == NULL)
1035 RETURN_ERR_OCCURRED;
Victor Stinner37bb2892020-06-19 11:45:31 +02001036 *psize = len;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001037 }
Victor Stinner5216e6d2010-06-08 21:45:51 +00001038 else
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001039 return converterr(c == 'Z' ? "str or None" : "str",
1040 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001041 format++;
1042 } else {
Serhiy Storchakad6e53da2015-04-19 21:11:30 +03001043 /* "u" or "Z" */
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001044 if (c == 'Z' && arg == Py_None)
1045 *p = NULL;
Victor Stinner06e49dd2010-06-13 18:21:50 +00001046 else if (PyUnicode_Check(arg)) {
Victor Stinnerbeac78b2011-10-11 21:55:01 +02001047 Py_ssize_t len;
1048 *p = PyUnicode_AsUnicodeAndSize(arg, &len);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001049 if (*p == NULL)
1050 RETURN_ERR_OCCURRED;
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001051 if (wcslen(*p) != (size_t)len) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001052 PyErr_SetString(PyExc_ValueError, "embedded null character");
1053 RETURN_ERR_OCCURRED;
1054 }
Victor Stinner06e49dd2010-06-13 18:21:50 +00001055 } else
Victor Stinner3c9e6e92010-06-24 22:31:12 +00001056 return converterr(c == 'Z' ? "str or None" : "str",
1057 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001058 }
1059 break;
Inada Naoki2c4928d2020-06-17 20:09:44 +09001060_Py_COMP_DIAG_POP
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001061 }
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001062
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001063 case 'e': {/* encoded string */
1064 char **buffer;
1065 const char *encoding;
1066 PyObject *s;
1067 int recode_strings;
1068 Py_ssize_t size;
1069 const char *ptr;
Jeremy Hylton4819e972001-10-11 14:40:37 +00001070
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001071 /* Get 'e' parameter: the encoding name */
1072 encoding = (const char *)va_arg(*p_va, const char *);
1073 if (encoding == NULL)
1074 encoding = PyUnicode_GetDefaultEncoding();
Martin v. Löwis423be952008-08-13 15:53:07 +00001075
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001076 /* Get output buffer parameter:
1077 's' (recode all objects via Unicode) or
1078 't' (only recode non-string objects)
1079 */
1080 if (*format == 's')
1081 recode_strings = 1;
1082 else if (*format == 't')
1083 recode_strings = 0;
1084 else
1085 return converterr(
1086 "(unknown parser marker combination)",
1087 arg, msgbuf, bufsize);
1088 buffer = (char **)va_arg(*p_va, char **);
1089 format++;
1090 if (buffer == NULL)
1091 return converterr("(buffer is NULL)",
1092 arg, msgbuf, bufsize);
Benjamin Peterson9edd2bd2008-08-27 00:31:37 +00001093
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001094 /* Encode object */
1095 if (!recode_strings &&
1096 (PyBytes_Check(arg) || PyByteArray_Check(arg))) {
1097 s = arg;
1098 Py_INCREF(s);
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02001099 if (PyBytes_Check(arg)) {
1100 size = PyBytes_GET_SIZE(s);
1101 ptr = PyBytes_AS_STRING(s);
1102 }
1103 else {
1104 size = PyByteArray_GET_SIZE(s);
1105 ptr = PyByteArray_AS_STRING(s);
1106 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001107 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001108 else if (PyUnicode_Check(arg)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001109 /* Encode object; use default error handling */
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001110 s = PyUnicode_AsEncodedString(arg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001111 encoding,
1112 NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001113 if (s == NULL)
1114 return converterr("(encoding failed)",
1115 arg, msgbuf, bufsize);
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001116 assert(PyBytes_Check(s));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 size = PyBytes_GET_SIZE(s);
1118 ptr = PyBytes_AS_STRING(s);
1119 if (ptr == NULL)
1120 ptr = "";
1121 }
Serhiy Storchaka21a663e2016-04-13 15:37:23 +03001122 else {
1123 return converterr(
1124 recode_strings ? "str" : "str, bytes or bytearray",
1125 arg, msgbuf, bufsize);
1126 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00001127
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001128 /* Write output; output is guaranteed to be 0-terminated */
1129 if (*format == '#') {
1130 /* Using buffer length parameter '#':
1131
1132 - if *buffer is NULL, a new buffer of the
1133 needed size is allocated and the data
1134 copied into it; *buffer is updated to point
1135 to the new buffer; the caller is
1136 responsible for PyMem_Free()ing it after
1137 usage
1138
1139 - if *buffer is not NULL, the data is
1140 copied to *buffer; *buffer_len has to be
1141 set to the size of the buffer on input;
1142 buffer overflow is signalled with an error;
1143 buffer has to provide enough room for the
1144 encoded string plus the trailing 0-byte
1145
1146 - in both cases, *buffer_len is updated to
1147 the size of the buffer /excluding/ the
1148 trailing 0-byte
1149
1150 */
Victor Stinner37bb2892020-06-19 11:45:31 +02001151 REQUIRE_PY_SSIZE_T_CLEAN;
1152 Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001153
1154 format++;
Victor Stinner37bb2892020-06-19 11:45:31 +02001155 if (psize == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001156 Py_DECREF(s);
1157 return converterr(
1158 "(buffer_len is NULL)",
1159 arg, msgbuf, bufsize);
1160 }
1161 if (*buffer == NULL) {
1162 *buffer = PyMem_NEW(char, size + 1);
1163 if (*buffer == NULL) {
1164 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001165 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001166 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001167 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001168 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001169 Py_DECREF(s);
1170 return converterr(
1171 "(cleanup problem)",
1172 arg, msgbuf, bufsize);
1173 }
1174 } else {
Victor Stinner37bb2892020-06-19 11:45:31 +02001175 if (size + 1 > *psize) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001176 Py_DECREF(s);
Serhiy Storchaka4cd63ef2016-02-08 01:22:47 +02001177 PyErr_Format(PyExc_ValueError,
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001178 "encoded string too long "
1179 "(%zd, maximum length %zd)",
Victor Stinner37bb2892020-06-19 11:45:31 +02001180 (Py_ssize_t)size, (Py_ssize_t)(*psize - 1));
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001181 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001182 }
1183 }
1184 memcpy(*buffer, ptr, size+1);
Serhiy Storchaka5bc6a7c2019-10-21 11:35:07 +03001185
Victor Stinner37bb2892020-06-19 11:45:31 +02001186 *psize = size;
1187 }
1188 else {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001189 /* Using a 0-terminated buffer:
1190
1191 - the encoded string has to be 0-terminated
1192 for this variant to work; if it is not, an
1193 error raised
1194
1195 - a new buffer of the needed size is
1196 allocated and the data copied into it;
1197 *buffer is updated to point to the new
1198 buffer; the caller is responsible for
1199 PyMem_Free()ing it after usage
1200
1201 */
1202 if ((Py_ssize_t)strlen(ptr) != size) {
1203 Py_DECREF(s);
1204 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001205 "encoded string without null bytes",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001206 arg, msgbuf, bufsize);
1207 }
1208 *buffer = PyMem_NEW(char, size + 1);
1209 if (*buffer == NULL) {
1210 Py_DECREF(s);
Victor Stinner2872e5b2010-06-06 20:38:02 +00001211 PyErr_NoMemory();
Victor Stinner6ab8e822011-01-04 11:16:49 +00001212 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001213 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001214 if (addcleanup(*buffer, freelist, cleanup_ptr)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 Py_DECREF(s);
1216 return converterr("(cleanup problem)",
1217 arg, msgbuf, bufsize);
1218 }
1219 memcpy(*buffer, ptr, size+1);
1220 }
1221 Py_DECREF(s);
1222 break;
1223 }
1224
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001225 case 'S': { /* PyBytes object */
1226 PyObject **p = va_arg(*p_va, PyObject **);
1227 if (PyBytes_Check(arg))
1228 *p = arg;
1229 else
1230 return converterr("bytes", arg, msgbuf, bufsize);
1231 break;
1232 }
1233
1234 case 'Y': { /* PyByteArray object */
1235 PyObject **p = va_arg(*p_va, PyObject **);
1236 if (PyByteArray_Check(arg))
1237 *p = arg;
1238 else
Victor Stinner5216e6d2010-06-08 21:45:51 +00001239 return converterr("bytearray", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001240 break;
1241 }
1242
1243 case 'U': { /* PyUnicode object */
1244 PyObject **p = va_arg(*p_va, PyObject **);
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001245 if (PyUnicode_Check(arg)) {
1246 if (PyUnicode_READY(arg) == -1)
1247 RETURN_ERR_OCCURRED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001248 *p = arg;
Victor Stinnera1b0c9f2012-05-29 12:30:29 +02001249 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001250 else
1251 return converterr("str", arg, msgbuf, bufsize);
1252 break;
1253 }
1254
1255 case 'O': { /* object */
1256 PyTypeObject *type;
1257 PyObject **p;
1258 if (*format == '!') {
1259 type = va_arg(*p_va, PyTypeObject*);
1260 p = va_arg(*p_va, PyObject **);
1261 format++;
Victor Stinnera102ed72020-02-07 02:24:48 +01001262 if (PyType_IsSubtype(Py_TYPE(arg), type))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001263 *p = arg;
1264 else
1265 return converterr(type->tp_name, arg, msgbuf, bufsize);
1266
1267 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001268 else if (*format == '&') {
1269 typedef int (*converter)(PyObject *, void *);
1270 converter convert = va_arg(*p_va, converter);
1271 void *addr = va_arg(*p_va, void *);
1272 int res;
1273 format++;
1274 if (! (res = (*convert)(arg, addr)))
1275 return converterr("(unspecified)",
1276 arg, msgbuf, bufsize);
1277 if (res == Py_CLEANUP_SUPPORTED &&
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001278 addcleanup(addr, freelist, convert) == -1)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001279 return converterr("(cleanup problem)",
1280 arg, msgbuf, bufsize);
1281 }
1282 else {
1283 p = va_arg(*p_va, PyObject **);
1284 *p = arg;
1285 }
1286 break;
1287 }
1288
1289
Victor Stinner25e8ec42010-06-25 00:02:38 +00001290 case 'w': { /* "w*": memory buffer, read-write access */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001291 void **p = va_arg(*p_va, void **);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292
Victor Stinner25e8ec42010-06-25 00:02:38 +00001293 if (*format != '*')
1294 return converterr(
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001295 "(invalid use of 'w' format character)",
Victor Stinner25e8ec42010-06-25 00:02:38 +00001296 arg, msgbuf, bufsize);
1297 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001298
Victor Stinner25e8ec42010-06-25 00:02:38 +00001299 /* Caller is interested in Py_buffer, and the object
1300 supports it directly. */
1301 if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) {
1302 PyErr_Clear();
R David Murray861470c2014-10-05 11:47:01 -04001303 return converterr("read-write bytes-like object",
1304 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 }
Victor Stinner8182b712010-07-28 00:40:58 +00001306 if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) {
1307 PyBuffer_Release((Py_buffer*)p);
1308 return converterr("contiguous buffer", arg, msgbuf, bufsize);
1309 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001310 if (addcleanup(p, freelist, cleanup_buffer)) {
Victor Stinner25e8ec42010-06-25 00:02:38 +00001311 return converterr(
1312 "(cleanup problem)",
1313 arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001314 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001315 break;
1316 }
1317
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001318 default:
Serhiy Storchakac4b813d2016-02-08 01:06:11 +02001319 return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001320
1321 }
1322
1323 *p_format = format;
1324 return NULL;
Victor Stinner6ab8e822011-01-04 11:16:49 +00001325
Victor Stinner37bb2892020-06-19 11:45:31 +02001326#undef REQUIRE_PY_SSIZE_T_CLEAN
Victor Stinner6ab8e822011-01-04 11:16:49 +00001327#undef RETURN_ERR_OCCURRED
Guido van Rossumfe3f1a21994-09-29 09:42:55 +00001328}
Guido van Rossumaa354651996-08-19 19:32:04 +00001329
Martin v. Löwis18e16552006-02-15 17:27:45 +00001330static Py_ssize_t
Serhiy Storchaka85b0f5b2016-11-20 10:16:47 +02001331convertbuffer(PyObject *arg, const void **p, const char **errmsg)
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001332{
Victor Stinner5cb62392010-06-06 20:27:51 +00001333 PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001334 Py_ssize_t count;
1335 Py_buffer view;
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001336
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001337 *errmsg = NULL;
1338 *p = NULL;
Victor Stinner8182b712010-07-28 00:40:58 +00001339 if (pb != NULL && pb->bf_releasebuffer != NULL) {
R David Murray861470c2014-10-05 11:47:01 -04001340 *errmsg = "read-only bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001341 return -1;
1342 }
Travis E. Oliphantb99f7622007-08-18 11:21:56 +00001343
Victor Stinner8182b712010-07-28 00:40:58 +00001344 if (getbuffer(arg, &view, errmsg) < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001345 return -1;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001346 count = view.len;
1347 *p = view.buf;
1348 PyBuffer_Release(&view);
1349 return count;
Jeremy Hylton1cb7aa32001-05-29 17:37:05 +00001350}
Guido van Rossumaa354651996-08-19 19:32:04 +00001351
Martin v. Löwis423be952008-08-13 15:53:07 +00001352static int
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02001353getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg)
Martin v. Löwis423be952008-08-13 15:53:07 +00001354{
Victor Stinner8182b712010-07-28 00:40:58 +00001355 if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) {
R David Murray861470c2014-10-05 11:47:01 -04001356 *errmsg = "bytes-like object";
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001357 return -1;
1358 }
Victor Stinner5cb62392010-06-06 20:27:51 +00001359 if (!PyBuffer_IsContiguous(view, 'C')) {
Victor Stinner21e09482010-06-24 22:57:10 +00001360 PyBuffer_Release(view);
Victor Stinner5cb62392010-06-06 20:27:51 +00001361 *errmsg = "contiguous buffer";
1362 return -1;
1363 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001364 return 0;
Martin v. Löwis423be952008-08-13 15:53:07 +00001365}
1366
Guido van Rossumaa354651996-08-19 19:32:04 +00001367/* Support for keyword arguments donated by
1368 Geoff Philbrick <philbric@delphi.hks.com> */
1369
Tim Petersf8cd3e82001-10-27 04:26:57 +00001370/* Return false (0) for error, else true. */
Fred Drake563dfc22001-10-23 14:41:08 +00001371int
1372PyArg_ParseTupleAndKeywords(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001373 PyObject *keywords,
1374 const char *format,
1375 char **kwlist, ...)
Guido van Rossumaa354651996-08-19 19:32:04 +00001376{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 int retval;
1378 va_list va;
Tim Peters45772cd2001-10-27 03:58:40 +00001379
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 if ((args == NULL || !PyTuple_Check(args)) ||
1381 (keywords != NULL && !PyDict_Check(keywords)) ||
1382 format == NULL ||
1383 kwlist == NULL)
1384 {
1385 PyErr_BadInternalCall();
1386 return 0;
1387 }
Tim Peters45772cd2001-10-27 03:58:40 +00001388
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001389 va_start(va, kwlist);
1390 retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0);
1391 va_end(va);
1392 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001393}
1394
Vinay Sajip0b60f642019-10-15 08:26:12 +01001395PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001396_PyArg_ParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 PyObject *keywords,
1398 const char *format,
1399 char **kwlist, ...)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001400{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 int retval;
1402 va_list va;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001403
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 if ((args == NULL || !PyTuple_Check(args)) ||
1405 (keywords != NULL && !PyDict_Check(keywords)) ||
1406 format == NULL ||
1407 kwlist == NULL)
1408 {
1409 PyErr_BadInternalCall();
1410 return 0;
1411 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001412
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001413 va_start(va, kwlist);
1414 retval = vgetargskeywords(args, keywords, format,
1415 kwlist, &va, FLAG_SIZE_T);
1416 va_end(va);
1417 return retval;
Guido van Rossumaa354651996-08-19 19:32:04 +00001418}
1419
1420
Brett Cannon711e7d92004-07-10 22:20:32 +00001421int
1422PyArg_VaParseTupleAndKeywords(PyObject *args,
Jeremy Hyltonaf68c872005-12-10 18:50:16 +00001423 PyObject *keywords,
Guido van Rossum98297ee2007-11-06 21:34:58 +00001424 const char *format,
Martin v. Löwis15e62742006-02-27 16:46:16 +00001425 char **kwlist, va_list va)
Brett Cannon711e7d92004-07-10 22:20:32 +00001426{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 int retval;
1428 va_list lva;
Brett Cannon711e7d92004-07-10 22:20:32 +00001429
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 if ((args == NULL || !PyTuple_Check(args)) ||
1431 (keywords != NULL && !PyDict_Check(keywords)) ||
1432 format == NULL ||
1433 kwlist == NULL)
1434 {
1435 PyErr_BadInternalCall();
1436 return 0;
1437 }
Brett Cannon711e7d92004-07-10 22:20:32 +00001438
Benjamin Peterson0c212142016-09-20 20:39:33 -07001439 va_copy(lva, va);
Brett Cannon711e7d92004-07-10 22:20:32 +00001440
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001441 retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001442 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 return retval;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001444}
1445
Vinay Sajip0b60f642019-10-15 08:26:12 +01001446PyAPI_FUNC(int)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001447_PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001448 PyObject *keywords,
1449 const char *format,
1450 char **kwlist, va_list va)
Martin v. Löwis18e16552006-02-15 17:27:45 +00001451{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 int retval;
1453 va_list lva;
Martin v. Löwis18e16552006-02-15 17:27:45 +00001454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 if ((args == NULL || !PyTuple_Check(args)) ||
1456 (keywords != NULL && !PyDict_Check(keywords)) ||
1457 format == NULL ||
1458 kwlist == NULL)
1459 {
1460 PyErr_BadInternalCall();
1461 return 0;
1462 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00001463
Benjamin Peterson0c212142016-09-20 20:39:33 -07001464 va_copy(lva, va);
Martin v. Löwis18e16552006-02-15 17:27:45 +00001465
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001466 retval = vgetargskeywords(args, keywords, format,
1467 kwlist, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001468 va_end(lva);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 return retval;
Brett Cannon711e7d92004-07-10 22:20:32 +00001470}
1471
Vinay Sajip0b60f642019-10-15 08:26:12 +01001472PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001473_PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1474 struct _PyArg_Parser *parser, ...)
1475{
1476 int retval;
1477 va_list va;
1478
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001479 va_start(va, parser);
1480 retval = vgetargskeywordsfast(args, keywords, parser, &va, 0);
1481 va_end(va);
1482 return retval;
1483}
1484
Vinay Sajip0b60f642019-10-15 08:26:12 +01001485PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001486_PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1487 struct _PyArg_Parser *parser, ...)
1488{
1489 int retval;
1490 va_list va;
1491
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001492 va_start(va, parser);
1493 retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T);
1494 va_end(va);
1495 return retval;
1496}
1497
Vinay Sajip0b60f642019-10-15 08:26:12 +01001498PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001499_PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001500 struct _PyArg_Parser *parser, ...)
1501{
1502 int retval;
1503 va_list va;
1504
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001505 va_start(va, parser);
1506 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0);
1507 va_end(va);
1508 return retval;
1509}
1510
Vinay Sajip0b60f642019-10-15 08:26:12 +01001511PyAPI_FUNC(int)
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02001512_PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001513 struct _PyArg_Parser *parser, ...)
1514{
1515 int retval;
1516 va_list va;
1517
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001518 va_start(va, parser);
1519 retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T);
1520 va_end(va);
1521 return retval;
1522}
1523
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001524
Vinay Sajip0b60f642019-10-15 08:26:12 +01001525PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001526_PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords,
1527 struct _PyArg_Parser *parser, va_list va)
1528{
1529 int retval;
1530 va_list lva;
1531
Benjamin Peterson0c212142016-09-20 20:39:33 -07001532 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001533
1534 retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001535 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001536 return retval;
1537}
1538
Vinay Sajip0b60f642019-10-15 08:26:12 +01001539PyAPI_FUNC(int)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001540_PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords,
1541 struct _PyArg_Parser *parser, va_list va)
1542{
1543 int retval;
1544 va_list lva;
1545
Benjamin Peterson0c212142016-09-20 20:39:33 -07001546 va_copy(lva, va);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001547
1548 retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T);
Christian Heimes2f2fee12016-09-21 11:37:27 +02001549 va_end(lva);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001550 return retval;
1551}
1552
1553int
Benjamin Petersonfb886362010-04-24 18:21:17 +00001554PyArg_ValidateKeywordArguments(PyObject *kwargs)
1555{
Benjamin Petersonf6096542010-11-17 22:33:12 +00001556 if (!PyDict_Check(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001557 PyErr_BadInternalCall();
1558 return 0;
1559 }
1560 if (!_PyDict_HasOnlyStringKeys(kwargs)) {
1561 PyErr_SetString(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001562 "keywords must be strings");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001563 return 0;
1564 }
1565 return 1;
Benjamin Petersonfb886362010-04-24 18:21:17 +00001566}
1567
Christian Heimes380f7f22008-02-28 11:19:05 +00001568#define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':')
Brett Cannon711e7d92004-07-10 22:20:32 +00001569
Guido van Rossumaa354651996-08-19 19:32:04 +00001570static int
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001571vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001572 char **kwlist, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00001573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 char msgbuf[512];
1575 int levels[32];
Serhiy Storchaka17414412017-01-17 10:07:25 +02001576 const char *fname, *msg, *custom_msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001577 int min = INT_MAX;
Larry Hastings83a9f482012-03-20 20:06:16 +00001578 int max = INT_MAX;
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001579 int i, pos, len;
1580 int skip = 0;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001581 Py_ssize_t nargs, nkwargs;
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001582 PyObject *current_arg;
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001583 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
Benjamin Peterson40be9e52014-02-11 10:09:27 -05001584 freelist_t freelist;
1585
1586 freelist.entries = static_entries;
1587 freelist.first_available = 0;
1588 freelist.entries_malloced = 0;
Tim Petersf4331c12001-10-27 00:17:34 +00001589
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 assert(args != NULL && PyTuple_Check(args));
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001591 assert(kwargs == NULL || PyDict_Check(kwargs));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001592 assert(format != NULL);
1593 assert(kwlist != NULL);
1594 assert(p_va != NULL);
Tim Peters45772cd2001-10-27 03:58:40 +00001595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 /* grab the function name or custom error msg first (mutually exclusive) */
1597 fname = strchr(format, ':');
1598 if (fname) {
1599 fname++;
1600 custom_msg = NULL;
1601 }
1602 else {
1603 custom_msg = strchr(format,';');
1604 if (custom_msg)
1605 custom_msg++;
1606 }
Christian Heimes380f7f22008-02-28 11:19:05 +00001607
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001608 /* scan kwlist and count the number of positional-only parameters */
1609 for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) {
1610 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001611 /* scan kwlist and get greatest possible nbr of args */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001612 for (len = pos; kwlist[len]; len++) {
1613 if (!*kwlist[len]) {
1614 PyErr_SetString(PyExc_SystemError,
1615 "Empty keyword parameter name");
1616 return cleanreturn(0, &freelist);
1617 }
1618 }
Tim Petersf8cd3e82001-10-27 04:26:57 +00001619
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001620 if (len > STATIC_FREELIST_ENTRIES) {
1621 freelist.entries = PyMem_NEW(freelistentry_t, len);
1622 if (freelist.entries == NULL) {
1623 PyErr_NoMemory();
1624 return 0;
1625 }
1626 freelist.entries_malloced = 1;
Benjamin Peterson7ed67272012-03-16 12:21:02 -05001627 }
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001628
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 nargs = PyTuple_GET_SIZE(args);
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001630 nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs);
1631 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03001632 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
1633 messages in some special cases (see bpo-31229). */
Victor Stinner6ced7c42011-03-21 18:15:42 +01001634 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001635 "%.200s%s takes at most %d %sargument%s (%zd given)",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 (fname == NULL) ? "function" : fname,
1637 (fname == NULL) ? "" : "()",
1638 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03001639 (nargs == 0) ? "keyword " : "",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001640 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001641 nargs + nkwargs);
Benjamin Peterson01feaec2012-03-16 13:25:58 -05001642 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001643 }
Tim Petersc2f01122001-10-27 07:25:06 +00001644
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001645 /* convert tuple args and keyword args in same loop, using kwlist to drive process */
1646 for (i = 0; i < len; i++) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001647 if (*format == '|') {
Larry Hastings83a9f482012-03-20 20:06:16 +00001648 if (min != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001649 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001650 "Invalid format string (| specified twice)");
1651 return cleanreturn(0, &freelist);
1652 }
1653
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001654 min = i;
1655 format++;
Larry Hastings83a9f482012-03-20 20:06:16 +00001656
1657 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001658 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001659 "Invalid format string ($ before |)");
1660 return cleanreturn(0, &freelist);
1661 }
1662 }
1663 if (*format == '$') {
1664 if (max != INT_MAX) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001665 PyErr_SetString(PyExc_SystemError,
Larry Hastings83a9f482012-03-20 20:06:16 +00001666 "Invalid format string ($ specified twice)");
1667 return cleanreturn(0, &freelist);
1668 }
1669
1670 max = i;
1671 format++;
1672
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001673 if (max < pos) {
1674 PyErr_SetString(PyExc_SystemError,
1675 "Empty parameter name after $");
1676 return cleanreturn(0, &freelist);
1677 }
1678 if (skip) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001679 /* Now we know the minimal and the maximal numbers of
1680 * positional arguments and can raise an exception with
1681 * informative message (see below). */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001682 break;
1683 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001684 if (max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001685 if (max == 0) {
1686 PyErr_Format(PyExc_TypeError,
1687 "%.200s%s takes no positional arguments",
1688 (fname == NULL) ? "function" : fname,
1689 (fname == NULL) ? "" : "()");
1690 }
1691 else {
1692 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301693 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001694 " (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001695 (fname == NULL) ? "function" : fname,
1696 (fname == NULL) ? "" : "()",
1697 (min != INT_MAX) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301698 max,
1699 max == 1 ? "" : "s",
1700 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03001701 }
Larry Hastings83a9f482012-03-20 20:06:16 +00001702 return cleanreturn(0, &freelist);
1703 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001704 }
1705 if (IS_END_OF_FORMAT(*format)) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001706 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001707 "More keyword list entries (%d) than "
1708 "format specifiers (%d)", len, i);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001709 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001710 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001711 if (!skip) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001712 if (i < nargs) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001713 current_arg = PyTuple_GET_ITEM(args, i);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001714 }
1715 else if (nkwargs && i >= pos) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001716 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
1717 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001718 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001719 }
1720 else if (PyErr_Occurred()) {
1721 return cleanreturn(0, &freelist);
1722 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001723 }
1724 else {
1725 current_arg = NULL;
1726 }
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001727
1728 if (current_arg) {
1729 msg = convertitem(current_arg, &format, p_va, flags,
1730 levels, msgbuf, sizeof(msgbuf), &freelist);
1731 if (msg) {
1732 seterror(i+1, msg, levels, fname, custom_msg);
1733 return cleanreturn(0, &freelist);
1734 }
1735 continue;
1736 }
1737
1738 if (i < min) {
1739 if (i < pos) {
1740 assert (min == INT_MAX);
1741 assert (max == INT_MAX);
1742 skip = 1;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001743 /* At that moment we still don't know the minimal and
1744 * the maximal numbers of positional arguments. Raising
1745 * an exception is deferred until we encounter | and $
1746 * or the end of the format. */
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001747 }
1748 else {
Michael Seifert64c8f702017-04-09 09:47:12 +02001749 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
1750 "argument '%s' (pos %d)",
1751 (fname == NULL) ? "function" : fname,
1752 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001753 kwlist[i], i+1);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001754 return cleanreturn(0, &freelist);
1755 }
1756 }
1757 /* current code reports success when all required args
1758 * fulfilled and no keyword args left, with no further
1759 * validation. XXX Maybe skip this in debug build ?
1760 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001761 if (!nkwargs && !skip) {
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001762 return cleanreturn(1, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001763 }
1764 }
Guido van Rossumaa354651996-08-19 19:32:04 +00001765
Leo Ariasc3d95082018-02-03 18:36:10 -06001766 /* We are into optional args, skip through to any remaining
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001767 * keyword args */
1768 msg = skipitem(&format, p_va, flags);
1769 if (msg) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001770 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001771 format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001772 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001773 }
1774 }
Tim Petersb054be42001-10-27 05:07:41 +00001775
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001776 if (skip) {
1777 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05301778 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001779 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001780 (fname == NULL) ? "function" : fname,
1781 (fname == NULL) ? "" : "()",
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001782 (Py_MIN(pos, min) < i) ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05301783 Py_MIN(pos, min),
1784 Py_MIN(pos, min) == 1 ? "" : "s",
1785 nargs);
Serhiy Storchakaf41b82f2016-06-09 16:30:29 +03001786 return cleanreturn(0, &freelist);
1787 }
1788
Larry Hastings83a9f482012-03-20 20:06:16 +00001789 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchakaa9725f82016-02-11 12:41:40 +02001790 PyErr_Format(PyExc_SystemError,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001791 "more argument specifiers than keyword list entries "
1792 "(remaining format:'%s')", format);
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001793 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 }
Tim Petersc2f01122001-10-27 07:25:06 +00001795
Victor Stinnerc0083fc2017-01-17 00:37:42 +01001796 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02001797 PyObject *key;
1798 Py_ssize_t j;
1799 /* make sure there are no arguments given by name and position */
1800 for (i = pos; i < nargs; i++) {
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001801 current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]);
Serhiy Storchaka17414412017-01-17 10:07:25 +02001802 if (current_arg) {
1803 /* arg present in tuple and in dict */
1804 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02001805 "argument for %.200s%s given by name ('%s') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02001806 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02001807 (fname == NULL) ? "function" : fname,
1808 (fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02001809 kwlist[i], i+1);
1810 return cleanreturn(0, &freelist);
1811 }
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001812 else if (PyErr_Occurred()) {
1813 return cleanreturn(0, &freelist);
1814 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001815 }
1816 /* make sure there are no extraneous keyword arguments */
1817 j = 0;
1818 while (PyDict_Next(kwargs, &j, &key, NULL)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001819 int match = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001820 if (!PyUnicode_Check(key)) {
1821 PyErr_SetString(PyExc_TypeError,
1822 "keywords must be strings");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001823 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001824 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02001825 for (i = pos; i < len; i++) {
1826 if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) {
Antoine Pitrou7056cb22013-02-17 01:04:57 +01001827 match = 1;
1828 break;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001829 }
1830 }
1831 if (!match) {
1832 PyErr_Format(PyExc_TypeError,
Victor Stinner93b55132010-05-19 00:54:06 +00001833 "'%U' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02001834 "argument for %.200s%s",
1835 key,
1836 (fname == NULL) ? "this function" : fname,
1837 (fname == NULL) ? "" : "()");
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001838 return cleanreturn(0, &freelist);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 }
1840 }
1841 }
1842
Jean-Paul Calderonec961b4a2012-03-16 08:51:42 -04001843 return cleanreturn(1, &freelist);
Guido van Rossumaa354651996-08-19 19:32:04 +00001844}
1845
1846
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001847/* List of static parsers. */
1848static struct _PyArg_Parser *static_arg_parsers = NULL;
1849
1850static int
1851parser_init(struct _PyArg_Parser *parser)
1852{
1853 const char * const *keywords;
1854 const char *format, *msg;
1855 int i, len, min, max, nkw;
1856 PyObject *kwtuple;
1857
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001858 assert(parser->keywords != NULL);
1859 if (parser->kwtuple != NULL) {
1860 return 1;
1861 }
1862
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001863 keywords = parser->keywords;
1864 /* scan keywords and count the number of positional-only parameters */
1865 for (i = 0; keywords[i] && !*keywords[i]; i++) {
1866 }
1867 parser->pos = i;
1868 /* scan keywords and get greatest possible nbr of args */
1869 for (; keywords[i]; i++) {
1870 if (!*keywords[i]) {
1871 PyErr_SetString(PyExc_SystemError,
1872 "Empty keyword parameter name");
1873 return 0;
1874 }
1875 }
1876 len = i;
1877
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001878 format = parser->format;
Serhiy Storchaka31913912019-03-14 10:32:22 +02001879 if (format) {
1880 /* grab the function name or custom error msg first (mutually exclusive) */
1881 parser->fname = strchr(parser->format, ':');
1882 if (parser->fname) {
1883 parser->fname++;
1884 parser->custom_msg = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001885 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001886 else {
1887 parser->custom_msg = strchr(parser->format,';');
1888 if (parser->custom_msg)
1889 parser->custom_msg++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001890 }
Serhiy Storchaka31913912019-03-14 10:32:22 +02001891
1892 min = max = INT_MAX;
1893 for (i = 0; i < len; i++) {
1894 if (*format == '|') {
1895 if (min != INT_MAX) {
1896 PyErr_SetString(PyExc_SystemError,
1897 "Invalid format string (| specified twice)");
1898 return 0;
1899 }
1900 if (max != INT_MAX) {
1901 PyErr_SetString(PyExc_SystemError,
1902 "Invalid format string ($ before |)");
1903 return 0;
1904 }
1905 min = i;
1906 format++;
1907 }
1908 if (*format == '$') {
1909 if (max != INT_MAX) {
1910 PyErr_SetString(PyExc_SystemError,
1911 "Invalid format string ($ specified twice)");
1912 return 0;
1913 }
1914 if (i < parser->pos) {
1915 PyErr_SetString(PyExc_SystemError,
1916 "Empty parameter name after $");
1917 return 0;
1918 }
1919 max = i;
1920 format++;
1921 }
1922 if (IS_END_OF_FORMAT(*format)) {
1923 PyErr_Format(PyExc_SystemError,
1924 "More keyword list entries (%d) than "
1925 "format specifiers (%d)", len, i);
1926 return 0;
1927 }
1928
1929 msg = skipitem(&format, NULL, 0);
1930 if (msg) {
1931 PyErr_Format(PyExc_SystemError, "%s: '%s'", msg,
1932 format);
1933 return 0;
1934 }
1935 }
1936 parser->min = Py_MIN(min, len);
1937 parser->max = Py_MIN(max, len);
1938
1939 if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001940 PyErr_Format(PyExc_SystemError,
Serhiy Storchaka31913912019-03-14 10:32:22 +02001941 "more argument specifiers than keyword list entries "
1942 "(remaining format:'%s')", format);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001943 return 0;
1944 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03001945 }
1946
1947 nkw = len - parser->pos;
1948 kwtuple = PyTuple_New(nkw);
1949 if (kwtuple == NULL) {
1950 return 0;
1951 }
1952 keywords = parser->keywords + parser->pos;
1953 for (i = 0; i < nkw; i++) {
1954 PyObject *str = PyUnicode_FromString(keywords[i]);
1955 if (str == NULL) {
1956 Py_DECREF(kwtuple);
1957 return 0;
1958 }
1959 PyUnicode_InternInPlace(&str);
1960 PyTuple_SET_ITEM(kwtuple, i, str);
1961 }
1962 parser->kwtuple = kwtuple;
1963
1964 assert(parser->next == NULL);
1965 parser->next = static_arg_parsers;
1966 static_arg_parsers = parser;
1967 return 1;
1968}
1969
1970static void
1971parser_clear(struct _PyArg_Parser *parser)
1972{
1973 Py_CLEAR(parser->kwtuple);
1974}
1975
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001976static PyObject*
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02001977find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key)
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001978{
1979 Py_ssize_t i, nkwargs;
1980
1981 nkwargs = PyTuple_GET_SIZE(kwnames);
Sebastian Berg75bb07e2019-12-18 00:51:22 -06001982 for (i = 0; i < nkwargs; i++) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001983 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
1984
Sebastian Berg75bb07e2019-12-18 00:51:22 -06001985 /* kwname == key will normally find a match in since keyword keys
1986 should be interned strings; if not retry below in a new loop. */
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001987 if (kwname == key) {
1988 return kwstack[i];
1989 }
Sebastian Berg75bb07e2019-12-18 00:51:22 -06001990 }
1991
1992 for (i = 0; i < nkwargs; i++) {
1993 PyObject *kwname = PyTuple_GET_ITEM(kwnames, i);
Jeroen Demeyer05677862019-08-16 12:41:27 +02001994 assert(PyUnicode_Check(kwname));
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07001995 if (_PyUnicode_EQ(kwname, key)) {
1996 return kwstack[i];
1997 }
1998 }
1999 return NULL;
2000}
2001
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002002static int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002003vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs,
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002004 PyObject *kwargs, PyObject *kwnames,
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002005 struct _PyArg_Parser *parser,
2006 va_list *p_va, int flags)
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002007{
2008 PyObject *kwtuple;
2009 char msgbuf[512];
2010 int levels[32];
2011 const char *format;
2012 const char *msg;
2013 PyObject *keyword;
2014 int i, pos, len;
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002015 Py_ssize_t nkwargs;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002016 PyObject *current_arg;
2017 freelistentry_t static_entries[STATIC_FREELIST_ENTRIES];
2018 freelist_t freelist;
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002019 PyObject *const *kwstack = NULL;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002020
2021 freelist.entries = static_entries;
2022 freelist.first_available = 0;
2023 freelist.entries_malloced = 0;
2024
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002025 assert(kwargs == NULL || PyDict_Check(kwargs));
Serhiy Storchaka17414412017-01-17 10:07:25 +02002026 assert(kwargs == NULL || kwnames == NULL);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002027 assert(p_va != NULL);
2028
Victor Stinner80ab22f2017-01-16 23:16:47 +01002029 if (parser == NULL) {
2030 PyErr_BadInternalCall();
2031 return 0;
2032 }
2033
2034 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2035 PyErr_BadInternalCall();
2036 return 0;
2037 }
2038
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002039 if (!parser_init(parser)) {
2040 return 0;
2041 }
2042
2043 kwtuple = parser->kwtuple;
2044 pos = parser->pos;
Segev Finere7bc7aa2017-07-26 18:58:25 +03002045 len = pos + (int)PyTuple_GET_SIZE(kwtuple);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002046
2047 if (len > STATIC_FREELIST_ENTRIES) {
2048 freelist.entries = PyMem_NEW(freelistentry_t, len);
2049 if (freelist.entries == NULL) {
2050 PyErr_NoMemory();
2051 return 0;
2052 }
2053 freelist.entries_malloced = 1;
2054 }
2055
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002056 if (kwargs != NULL) {
2057 nkwargs = PyDict_GET_SIZE(kwargs);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002058 }
2059 else if (kwnames != NULL) {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002060 nkwargs = PyTuple_GET_SIZE(kwnames);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002061 kwstack = args + nargs;
2062 }
2063 else {
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002064 nkwargs = 0;
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002065 }
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002066 if (nargs + nkwargs > len) {
Oren Milmanbf9075a2017-08-23 21:16:48 +03002067 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2068 messages in some special cases (see bpo-31229). */
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002069 PyErr_Format(PyExc_TypeError,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002070 "%.200s%s takes at most %d %sargument%s (%zd given)",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002071 (parser->fname == NULL) ? "function" : parser->fname,
2072 (parser->fname == NULL) ? "" : "()",
2073 len,
Oren Milmanbf9075a2017-08-23 21:16:48 +03002074 (nargs == 0) ? "keyword " : "",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002075 (len == 1) ? "" : "s",
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002076 nargs + nkwargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002077 return cleanreturn(0, &freelist);
2078 }
2079 if (parser->max < nargs) {
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002080 if (parser->max == 0) {
2081 PyErr_Format(PyExc_TypeError,
Serhiy Storchakaf9f1cca2017-06-09 19:27:06 +03002082 "%.200s%s takes no positional arguments",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002083 (parser->fname == NULL) ? "function" : parser->fname,
2084 (parser->fname == NULL) ? "" : "()");
2085 }
2086 else {
2087 PyErr_Format(PyExc_TypeError,
Serhiy Storchaka2c0d3f42019-03-14 10:06:05 +02002088 "%.200s%s takes %s %d positional argument%s (%zd given)",
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002089 (parser->fname == NULL) ? "function" : parser->fname,
2090 (parser->fname == NULL) ? "" : "()",
Serhiy Storchakaf2f55e72019-03-13 23:03:22 +02002091 (parser->min < parser->max) ? "at most" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302092 parser->max,
2093 parser->max == 1 ? "" : "s",
2094 nargs);
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002095 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002096 return cleanreturn(0, &freelist);
2097 }
2098
2099 format = parser->format;
2100 /* convert tuple args and keyword args in same loop, using kwtuple to drive process */
2101 for (i = 0; i < len; i++) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002102 if (*format == '|') {
2103 format++;
2104 }
2105 if (*format == '$') {
2106 format++;
2107 }
2108 assert(!IS_END_OF_FORMAT(*format));
2109
Serhiy Storchaka17414412017-01-17 10:07:25 +02002110 if (i < nargs) {
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002111 current_arg = args[i];
Victor Stinnera9efb2f2016-09-09 17:40:22 -07002112 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002113 else if (nkwargs && i >= pos) {
2114 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002115 if (kwargs != NULL) {
2116 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2117 if (!current_arg && PyErr_Occurred()) {
2118 return cleanreturn(0, &freelist);
2119 }
2120 }
2121 else {
2122 current_arg = find_keyword(kwnames, kwstack, keyword);
2123 }
2124 if (current_arg) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002125 --nkwargs;
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002126 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002127 }
2128 else {
2129 current_arg = NULL;
2130 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002131
2132 if (current_arg) {
2133 msg = convertitem(current_arg, &format, p_va, flags,
2134 levels, msgbuf, sizeof(msgbuf), &freelist);
2135 if (msg) {
2136 seterror(i+1, msg, levels, parser->fname, parser->custom_msg);
2137 return cleanreturn(0, &freelist);
2138 }
2139 continue;
2140 }
2141
2142 if (i < parser->min) {
2143 /* Less arguments than required */
2144 if (i < pos) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002145 Py_ssize_t min = Py_MIN(pos, parser->min);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002146 PyErr_Format(PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302147 "%.200s%s takes %s %d positional argument%s"
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02002148 " (%zd given)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002149 (parser->fname == NULL) ? "function" : parser->fname,
2150 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002151 min < parser->max ? "at least" : "exactly",
Xtreak63262782018-12-21 20:15:13 +05302152 min,
2153 min == 1 ? "" : "s",
2154 nargs);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002155 }
2156 else {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002157 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Michael Seifert64c8f702017-04-09 09:47:12 +02002158 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2159 "argument '%U' (pos %d)",
2160 (parser->fname == NULL) ? "function" : parser->fname,
2161 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002162 keyword, i+1);
2163 }
2164 return cleanreturn(0, &freelist);
2165 }
2166 /* current code reports success when all required args
2167 * fulfilled and no keyword args left, with no further
2168 * validation. XXX Maybe skip this in debug build ?
2169 */
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002170 if (!nkwargs) {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002171 return cleanreturn(1, &freelist);
2172 }
2173
Leo Ariasc3d95082018-02-03 18:36:10 -06002174 /* We are into optional args, skip through to any remaining
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002175 * keyword args */
2176 msg = skipitem(&format, p_va, flags);
2177 assert(msg == NULL);
2178 }
2179
2180 assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$'));
2181
Victor Stinnerc0083fc2017-01-17 00:37:42 +01002182 if (nkwargs > 0) {
Serhiy Storchaka17414412017-01-17 10:07:25 +02002183 Py_ssize_t j;
2184 /* make sure there are no arguments given by name and position */
2185 for (i = pos; i < nargs; i++) {
2186 keyword = PyTuple_GET_ITEM(kwtuple, i - pos);
Serhiy Storchakaa24107b2019-02-25 17:59:46 +02002187 if (kwargs != NULL) {
2188 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2189 if (!current_arg && PyErr_Occurred()) {
2190 return cleanreturn(0, &freelist);
2191 }
2192 }
2193 else {
2194 current_arg = find_keyword(kwnames, kwstack, keyword);
2195 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002196 if (current_arg) {
2197 /* arg present in tuple and in dict */
2198 PyErr_Format(PyExc_TypeError,
Michael Seifert64c8f702017-04-09 09:47:12 +02002199 "argument for %.200s%s given by name ('%U') "
Serhiy Storchaka17414412017-01-17 10:07:25 +02002200 "and position (%d)",
Michael Seifert64c8f702017-04-09 09:47:12 +02002201 (parser->fname == NULL) ? "function" : parser->fname,
2202 (parser->fname == NULL) ? "" : "()",
Serhiy Storchaka17414412017-01-17 10:07:25 +02002203 keyword, i+1);
2204 return cleanreturn(0, &freelist);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002205 }
2206 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002207 /* make sure there are no extraneous keyword arguments */
2208 j = 0;
2209 while (1) {
2210 int match;
2211 if (kwargs != NULL) {
2212 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2213 break;
2214 }
2215 else {
2216 if (j >= PyTuple_GET_SIZE(kwnames))
2217 break;
2218 keyword = PyTuple_GET_ITEM(kwnames, j);
2219 j++;
2220 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002221
Serhiy Storchaka17414412017-01-17 10:07:25 +02002222 match = PySequence_Contains(kwtuple, keyword);
2223 if (match <= 0) {
2224 if (!match) {
2225 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002226 "'%S' is an invalid keyword "
Michael Seifert64c8f702017-04-09 09:47:12 +02002227 "argument for %.200s%s",
2228 keyword,
2229 (parser->fname == NULL) ? "this function" : parser->fname,
2230 (parser->fname == NULL) ? "" : "()");
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002231 }
Serhiy Storchaka17414412017-01-17 10:07:25 +02002232 return cleanreturn(0, &freelist);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002233 }
2234 }
2235 }
2236
2237 return cleanreturn(1, &freelist);
2238}
2239
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002240static int
2241vgetargskeywordsfast(PyObject *args, PyObject *keywords,
2242 struct _PyArg_Parser *parser, va_list *p_va, int flags)
2243{
2244 PyObject **stack;
2245 Py_ssize_t nargs;
2246
Victor Stinner80ab22f2017-01-16 23:16:47 +01002247 if (args == NULL
2248 || !PyTuple_Check(args)
2249 || (keywords != NULL && !PyDict_Check(keywords)))
2250 {
2251 PyErr_BadInternalCall();
2252 return 0;
2253 }
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002254
Victor Stinnerd17a6932018-11-09 16:56:48 +01002255 stack = _PyTuple_ITEMS(args);
Victor Stinnerf0ccbbb2016-09-09 17:40:38 -07002256 nargs = PyTuple_GET_SIZE(args);
2257 return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL,
2258 parser, p_va, flags);
2259}
2260
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002261
Serhiy Storchaka31913912019-03-14 10:32:22 +02002262#undef _PyArg_UnpackKeywords
2263
2264PyObject * const *
2265_PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs,
2266 PyObject *kwargs, PyObject *kwnames,
2267 struct _PyArg_Parser *parser,
2268 int minpos, int maxpos, int minkw,
2269 PyObject **buf)
2270{
2271 PyObject *kwtuple;
2272 PyObject *keyword;
2273 int i, posonly, minposonly, maxargs;
2274 int reqlimit = minkw ? maxpos + minkw : minpos;
2275 Py_ssize_t nkwargs;
2276 PyObject *current_arg;
2277 PyObject * const *kwstack = NULL;
2278
2279 assert(kwargs == NULL || PyDict_Check(kwargs));
2280 assert(kwargs == NULL || kwnames == NULL);
2281
2282 if (parser == NULL) {
2283 PyErr_BadInternalCall();
2284 return NULL;
2285 }
2286
2287 if (kwnames != NULL && !PyTuple_Check(kwnames)) {
2288 PyErr_BadInternalCall();
2289 return NULL;
2290 }
2291
2292 if (args == NULL && nargs == 0) {
2293 args = buf;
2294 }
2295
2296 if (!parser_init(parser)) {
2297 return NULL;
2298 }
2299
2300 kwtuple = parser->kwtuple;
2301 posonly = parser->pos;
2302 minposonly = Py_MIN(posonly, minpos);
2303 maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple);
2304
2305 if (kwargs != NULL) {
2306 nkwargs = PyDict_GET_SIZE(kwargs);
2307 }
2308 else if (kwnames != NULL) {
2309 nkwargs = PyTuple_GET_SIZE(kwnames);
2310 kwstack = args + nargs;
2311 }
2312 else {
2313 nkwargs = 0;
2314 }
2315 if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) {
2316 /* Fast path. */
2317 return args;
2318 }
2319 if (nargs + nkwargs > maxargs) {
2320 /* Adding "keyword" (when nargs == 0) prevents producing wrong error
2321 messages in some special cases (see bpo-31229). */
2322 PyErr_Format(PyExc_TypeError,
2323 "%.200s%s takes at most %d %sargument%s (%zd given)",
2324 (parser->fname == NULL) ? "function" : parser->fname,
2325 (parser->fname == NULL) ? "" : "()",
2326 maxargs,
2327 (nargs == 0) ? "keyword " : "",
2328 (maxargs == 1) ? "" : "s",
2329 nargs + nkwargs);
2330 return NULL;
2331 }
2332 if (nargs > maxpos) {
2333 if (maxpos == 0) {
2334 PyErr_Format(PyExc_TypeError,
2335 "%.200s%s takes no positional arguments",
2336 (parser->fname == NULL) ? "function" : parser->fname,
2337 (parser->fname == NULL) ? "" : "()");
2338 }
2339 else {
2340 PyErr_Format(PyExc_TypeError,
2341 "%.200s%s takes %s %d positional argument%s (%zd given)",
2342 (parser->fname == NULL) ? "function" : parser->fname,
2343 (parser->fname == NULL) ? "" : "()",
2344 (minpos < maxpos) ? "at most" : "exactly",
2345 maxpos,
2346 (maxpos == 1) ? "" : "s",
2347 nargs);
2348 }
2349 return NULL;
2350 }
2351 if (nargs < minposonly) {
2352 PyErr_Format(PyExc_TypeError,
2353 "%.200s%s takes %s %d positional argument%s"
2354 " (%zd given)",
2355 (parser->fname == NULL) ? "function" : parser->fname,
2356 (parser->fname == NULL) ? "" : "()",
2357 minposonly < maxpos ? "at least" : "exactly",
2358 minposonly,
2359 minposonly == 1 ? "" : "s",
2360 nargs);
2361 return NULL;
2362 }
2363
2364 /* copy tuple args */
2365 for (i = 0; i < nargs; i++) {
2366 buf[i] = args[i];
2367 }
2368
2369 /* copy keyword args using kwtuple to drive process */
Serhiy Storchaka1b0393d2019-03-16 19:45:00 +02002370 for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) {
Serhiy Storchaka31913912019-03-14 10:32:22 +02002371 if (nkwargs) {
2372 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2373 if (kwargs != NULL) {
2374 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2375 if (!current_arg && PyErr_Occurred()) {
2376 return NULL;
2377 }
2378 }
2379 else {
2380 current_arg = find_keyword(kwnames, kwstack, keyword);
2381 }
2382 }
2383 else if (i >= reqlimit) {
2384 break;
2385 }
2386 else {
2387 current_arg = NULL;
2388 }
2389
2390 buf[i] = current_arg;
2391
2392 if (current_arg) {
2393 --nkwargs;
2394 }
2395 else if (i < minpos || (maxpos <= i && i < reqlimit)) {
2396 /* Less arguments than required */
2397 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2398 PyErr_Format(PyExc_TypeError, "%.200s%s missing required "
2399 "argument '%U' (pos %d)",
2400 (parser->fname == NULL) ? "function" : parser->fname,
2401 (parser->fname == NULL) ? "" : "()",
2402 keyword, i+1);
2403 return NULL;
2404 }
2405 }
2406
2407 if (nkwargs > 0) {
2408 Py_ssize_t j;
2409 /* make sure there are no arguments given by name and position */
2410 for (i = posonly; i < nargs; i++) {
2411 keyword = PyTuple_GET_ITEM(kwtuple, i - posonly);
2412 if (kwargs != NULL) {
2413 current_arg = PyDict_GetItemWithError(kwargs, keyword);
2414 if (!current_arg && PyErr_Occurred()) {
2415 return NULL;
2416 }
2417 }
2418 else {
2419 current_arg = find_keyword(kwnames, kwstack, keyword);
2420 }
2421 if (current_arg) {
2422 /* arg present in tuple and in dict */
2423 PyErr_Format(PyExc_TypeError,
2424 "argument for %.200s%s given by name ('%U') "
2425 "and position (%d)",
2426 (parser->fname == NULL) ? "function" : parser->fname,
2427 (parser->fname == NULL) ? "" : "()",
2428 keyword, i+1);
2429 return NULL;
2430 }
2431 }
2432 /* make sure there are no extraneous keyword arguments */
2433 j = 0;
2434 while (1) {
2435 int match;
2436 if (kwargs != NULL) {
2437 if (!PyDict_Next(kwargs, &j, &keyword, NULL))
2438 break;
2439 }
2440 else {
2441 if (j >= PyTuple_GET_SIZE(kwnames))
2442 break;
2443 keyword = PyTuple_GET_ITEM(kwnames, j);
2444 j++;
2445 }
2446
Serhiy Storchaka31913912019-03-14 10:32:22 +02002447 match = PySequence_Contains(kwtuple, keyword);
2448 if (match <= 0) {
2449 if (!match) {
2450 PyErr_Format(PyExc_TypeError,
Jeroen Demeyer05677862019-08-16 12:41:27 +02002451 "'%S' is an invalid keyword "
Serhiy Storchaka31913912019-03-14 10:32:22 +02002452 "argument for %.200s%s",
2453 keyword,
2454 (parser->fname == NULL) ? "this function" : parser->fname,
2455 (parser->fname == NULL) ? "" : "()");
2456 }
2457 return NULL;
2458 }
2459 }
2460 }
2461
2462 return buf;
2463}
2464
2465
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002466static const char *
Martin v. Löwis18e16552006-02-15 17:27:45 +00002467skipitem(const char **p_format, va_list *p_va, int flags)
Guido van Rossumaa354651996-08-19 19:32:04 +00002468{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 const char *format = *p_format;
2470 char c = *format++;
Guido van Rossum98297ee2007-11-06 21:34:58 +00002471
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 switch (c) {
Georg Brandl6dd14612005-09-14 19:29:53 +00002473
Larry Hastingsa3479012012-05-08 23:52:03 -07002474 /*
2475 * codes that take a single data pointer as an argument
2476 * (the type of the pointer is irrelevant)
2477 */
Georg Brandl6dd14612005-09-14 19:29:53 +00002478
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 case 'b': /* byte -- very short int */
2480 case 'B': /* byte as bitfield */
2481 case 'h': /* short int */
2482 case 'H': /* short int as bitfield */
2483 case 'i': /* int */
2484 case 'I': /* int sized bitfield */
2485 case 'l': /* long int */
2486 case 'k': /* long int sized bitfield */
Benjamin Petersonaf580df2016-09-06 10:46:49 -07002487 case 'L': /* long long */
2488 case 'K': /* long long sized bitfield */
Larry Hastingsa3479012012-05-08 23:52:03 -07002489 case 'n': /* Py_ssize_t */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002490 case 'f': /* float */
2491 case 'd': /* double */
2492 case 'D': /* complex double */
2493 case 'c': /* char */
2494 case 'C': /* unicode char */
Larry Hastings10ba07a2012-05-07 02:44:50 -07002495 case 'p': /* boolean predicate */
Larry Hastingsa3479012012-05-08 23:52:03 -07002496 case 'S': /* string object */
2497 case 'Y': /* string object */
2498 case 'U': /* unicode string object */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002500 if (p_va != NULL) {
2501 (void) va_arg(*p_va, void *);
2502 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002503 break;
2504 }
Martin v. Löwis18e16552006-02-15 17:27:45 +00002505
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 /* string codes */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002507
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002508 case 'e': /* string with encoding */
2509 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002510 if (p_va != NULL) {
2511 (void) va_arg(*p_va, const char *);
2512 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002513 if (!(*format == 's' || *format == 't'))
2514 /* after 'e', only 's' and 't' is allowed */
2515 goto err;
2516 format++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002517 }
Stefan Krahf432a322017-08-21 13:09:59 +02002518 /* fall through */
Guido van Rossum98297ee2007-11-06 21:34:58 +00002519
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 case 's': /* string */
2521 case 'z': /* string or None */
2522 case 'y': /* bytes */
2523 case 'u': /* unicode string */
Larry Hastingsd9e4a412012-05-08 03:51:18 -07002524 case 'Z': /* unicode string or None */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 case 'w': /* buffer, read-write */
2526 {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002527 if (p_va != NULL) {
2528 (void) va_arg(*p_va, char **);
2529 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 if (*format == '#') {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002531 if (p_va != NULL) {
2532 if (flags & FLAG_SIZE_T)
2533 (void) va_arg(*p_va, Py_ssize_t *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002534 else {
2535 if (PyErr_WarnEx(PyExc_DeprecationWarning,
2536 "PY_SSIZE_T_CLEAN will be required for '#' formats", 1)) {
2537 return NULL;
2538 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002539 (void) va_arg(*p_va, int *);
Inada Naokid3c72a22019-03-23 21:04:40 +09002540 }
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002541 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 format++;
Serhiy Storchaka504373c2018-07-11 17:41:43 +03002543 } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w')
2544 && *format == '*')
2545 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002546 format++;
2547 }
2548 break;
2549 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002550
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002551 case 'O': /* object */
2552 {
2553 if (*format == '!') {
2554 format++;
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002555 if (p_va != NULL) {
2556 (void) va_arg(*p_va, PyTypeObject*);
2557 (void) va_arg(*p_va, PyObject **);
2558 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002559 }
2560 else if (*format == '&') {
2561 typedef int (*converter)(PyObject *, void *);
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002562 if (p_va != NULL) {
2563 (void) va_arg(*p_va, converter);
2564 (void) va_arg(*p_va, void *);
2565 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002566 format++;
2567 }
2568 else {
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002569 if (p_va != NULL) {
2570 (void) va_arg(*p_va, PyObject **);
2571 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002572 }
2573 break;
2574 }
Guido van Rossum98297ee2007-11-06 21:34:58 +00002575
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002576 case '(': /* bypass tuple, not handled at all previously */
2577 {
Serhiy Storchakaef1585e2015-12-25 20:01:53 +02002578 const char *msg;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002579 for (;;) {
2580 if (*format==')')
2581 break;
2582 if (IS_END_OF_FORMAT(*format))
2583 return "Unmatched left paren in format "
2584 "string";
2585 msg = skipitem(&format, p_va, flags);
2586 if (msg)
2587 return msg;
2588 }
2589 format++;
2590 break;
2591 }
Christian Heimes380f7f22008-02-28 11:19:05 +00002592
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002593 case ')':
2594 return "Unmatched right paren in format string";
Christian Heimes380f7f22008-02-28 11:19:05 +00002595
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 default:
Georg Brandl6dd14612005-09-14 19:29:53 +00002597err:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002598 return "impossible<bad format char>";
Guido van Rossum98297ee2007-11-06 21:34:58 +00002599
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002600 }
Georg Brandl6dd14612005-09-14 19:29:53 +00002601
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002602 *p_format = format;
2603 return NULL;
Guido van Rossumaa354651996-08-19 19:32:04 +00002604}
Fred Drakee4616e62001-10-23 21:09:29 +00002605
2606
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002607#undef _PyArg_CheckPositional
Fred Drakee4616e62001-10-23 21:09:29 +00002608
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002609int
2610_PyArg_CheckPositional(const char *name, Py_ssize_t nargs,
2611 Py_ssize_t min, Py_ssize_t max)
2612{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002613 assert(min >= 0);
2614 assert(min <= max);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002615
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002616 if (nargs < min) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002617 if (name != NULL)
2618 PyErr_Format(
2619 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302620 "%.200s expected %s%zd argument%s, got %zd",
2621 name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002622 else
2623 PyErr_Format(
2624 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302625 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002626 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302627 (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002628 return 0;
2629 }
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002630
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002631 if (nargs == 0) {
Raymond Hettinger94230232016-03-26 03:02:48 -07002632 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002633 }
2634
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002635 if (nargs > max) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002636 if (name != NULL)
2637 PyErr_Format(
2638 PyExc_TypeError,
Xtreak1426daa2018-07-23 01:43:26 +05302639 "%.200s expected %s%zd argument%s, got %zd",
2640 name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002641 else
2642 PyErr_Format(
2643 PyExc_TypeError,
Xtreak63262782018-12-21 20:15:13 +05302644 "unpacked tuple should have %s%zd element%s,"
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002645 " but has %zd",
Xtreak63262782018-12-21 20:15:13 +05302646 (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002647 return 0;
2648 }
Raymond Hettinger94230232016-03-26 03:02:48 -07002649
Serhiy Storchaka4fa95912019-01-11 16:01:14 +02002650 return 1;
2651}
2652
2653static int
2654unpack_stack(PyObject *const *args, Py_ssize_t nargs, const char *name,
2655 Py_ssize_t min, Py_ssize_t max, va_list vargs)
2656{
2657 Py_ssize_t i;
2658 PyObject **o;
2659
2660 if (!_PyArg_CheckPositional(name, nargs, min, max)) {
2661 return 0;
2662 }
2663
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002664 for (i = 0; i < nargs; i++) {
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002665 o = va_arg(vargs, PyObject **);
2666 *o = args[i];
2667 }
2668 return 1;
2669}
2670
2671int
2672PyArg_UnpackTuple(PyObject *args, const char *name, Py_ssize_t min, Py_ssize_t max, ...)
2673{
2674 PyObject **stack;
2675 Py_ssize_t nargs;
2676 int retval;
2677 va_list vargs;
2678
2679 if (!PyTuple_Check(args)) {
2680 PyErr_SetString(PyExc_SystemError,
2681 "PyArg_UnpackTuple() argument list is not a tuple");
2682 return 0;
2683 }
Victor Stinnerd17a6932018-11-09 16:56:48 +01002684 stack = _PyTuple_ITEMS(args);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002685 nargs = PyTuple_GET_SIZE(args);
2686
Raymond Hettinger94230232016-03-26 03:02:48 -07002687#ifdef HAVE_STDARG_PROTOTYPES
2688 va_start(vargs, max);
2689#else
2690 va_start(vargs);
2691#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002692 retval = unpack_stack(stack, nargs, name, min, max, vargs);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002693 va_end(vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002694 return retval;
2695}
2696
2697int
Serhiy Storchakaa5552f02017-12-15 13:11:11 +02002698_PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name,
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002699 Py_ssize_t min, Py_ssize_t max, ...)
2700{
2701 int retval;
2702 va_list vargs;
2703
2704#ifdef HAVE_STDARG_PROTOTYPES
2705 va_start(vargs, max);
2706#else
2707 va_start(vargs);
2708#endif
Victor Stinnerfdbc3972017-02-01 17:42:18 +01002709 retval = unpack_stack(args, nargs, name, min, max, vargs);
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002710 va_end(vargs);
2711 return retval;
Fred Drakee4616e62001-10-23 21:09:29 +00002712}
Georg Brandl02c42872005-08-26 06:42:30 +00002713
2714
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002715#undef _PyArg_NoKeywords
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002716#undef _PyArg_NoKwnames
Serhiy Storchaka68a001d2017-02-06 10:41:46 +02002717#undef _PyArg_NoPositional
2718
Georg Brandl02c42872005-08-26 06:42:30 +00002719/* For type constructors that don't take keyword args
2720 *
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002721 * Sets a TypeError and returns 0 if the args/kwargs is
Thomas Wouters89f507f2006-12-13 04:49:30 +00002722 * not empty, returns 1 otherwise
Georg Brandl02c42872005-08-26 06:42:30 +00002723 */
2724int
Victor Stinner29d39cc2017-01-17 01:40:01 +01002725_PyArg_NoKeywords(const char *funcname, PyObject *kwargs)
Georg Brandl02c42872005-08-26 06:42:30 +00002726{
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002727 if (kwargs == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002728 return 1;
Victor Stinnerfe54dd82017-01-17 02:33:55 +01002729 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002730 if (!PyDict_CheckExact(kwargs)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002731 PyErr_BadInternalCall();
2732 return 0;
2733 }
Victor Stinner29d39cc2017-01-17 01:40:01 +01002734 if (PyDict_GET_SIZE(kwargs) == 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 return 1;
Victor Stinner29d39cc2017-01-17 01:40:01 +01002736 }
2737
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002738 PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments",
Victor Stinner29d39cc2017-01-17 01:40:01 +01002739 funcname);
2740 return 0;
2741}
2742
Victor Stinner29d39cc2017-01-17 01:40:01 +01002743int
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002744_PyArg_NoPositional(const char *funcname, PyObject *args)
2745{
2746 if (args == NULL)
2747 return 1;
2748 if (!PyTuple_CheckExact(args)) {
2749 PyErr_BadInternalCall();
2750 return 0;
2751 }
2752 if (PyTuple_GET_SIZE(args) == 0)
2753 return 1;
2754
Serhiy Storchaka5eb788b2017-06-06 18:45:22 +03002755 PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments",
Larry Hastingsb7ccb202014-01-18 23:50:21 -08002756 funcname);
2757 return 0;
2758}
2759
Dong-hee Na87ec86c2020-03-16 23:06:20 +09002760int
2761_PyArg_NoKwnames(const char *funcname, PyObject *kwnames)
2762{
2763 if (kwnames == NULL) {
2764 return 1;
2765 }
2766
2767 assert(PyTuple_CheckExact(kwnames));
2768
2769 if (PyTuple_GET_SIZE(kwnames) == 0) {
2770 return 1;
2771 }
2772
2773 PyErr_Format(PyExc_TypeError, "%s() takes no keyword arguments", funcname);
2774 return 0;
2775}
2776
Serhiy Storchaka9171a8b2016-08-14 10:52:18 +03002777void
2778_PyArg_Fini(void)
2779{
2780 struct _PyArg_Parser *tmp, *s = static_arg_parsers;
2781 while (s) {
2782 tmp = s->next;
2783 s->next = NULL;
2784 parser_clear(s);
2785 s = tmp;
2786 }
2787 static_arg_parsers = NULL;
2788}
2789
Thomas Wouters49fd7fa2006-04-21 10:40:58 +00002790#ifdef __cplusplus
2791};
2792#endif