Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 1 | |
| 2 | /* New getargs implementation */ |
| 3 | |
Guido van Rossum | 79f25d9 | 1997-04-29 20:08:16 +0000 | [diff] [blame] | 4 | #include "Python.h" |
Victor Stinner | 384621c | 2020-06-22 17:27:35 +0200 | [diff] [blame] | 5 | #include "pycore_tuple.h" // _PyTuple_ITEMS() |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 6 | |
Guido van Rossum | c1d5053 | 1996-08-21 23:38:24 +0000 | [diff] [blame] | 7 | #include <ctype.h> |
Benjamin Peterson | a853a8b | 2017-09-07 11:13:59 -0700 | [diff] [blame] | 8 | #include <float.h> |
Guido van Rossum | c1d5053 | 1996-08-21 23:38:24 +0000 | [diff] [blame] | 9 | |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 10 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 11 | #ifdef __cplusplus |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 12 | extern "C" { |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 13 | #endif |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 14 | int PyArg_Parse(PyObject *, const char *, ...); |
| 15 | int PyArg_ParseTuple(PyObject *, const char *, ...); |
| 16 | int PyArg_VaParse(PyObject *, const char *, va_list); |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 17 | |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 18 | int PyArg_ParseTupleAndKeywords(PyObject *, PyObject *, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 19 | const char *, char **, ...); |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 20 | int PyArg_VaParseTupleAndKeywords(PyObject *, PyObject *, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 21 | const char *, char **, va_list); |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 22 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 23 | int _PyArg_ParseTupleAndKeywordsFast(PyObject *, PyObject *, |
| 24 | struct _PyArg_Parser *, ...); |
| 25 | int _PyArg_VaParseTupleAndKeywordsFast(PyObject *, PyObject *, |
| 26 | struct _PyArg_Parser *, va_list); |
| 27 | |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 28 | #ifdef HAVE_DECLSPEC_DLL |
| 29 | /* Export functions */ |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 30 | PyAPI_FUNC(int) _PyArg_Parse_SizeT(PyObject *, const char *, ...); |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 31 | PyAPI_FUNC(int) _PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs, |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 32 | const char *format, ...); |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 33 | PyAPI_FUNC(int) _PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, |
| 34 | PyObject *kwnames, |
Benjamin Peterson | 819a46f | 2016-09-09 20:45:06 -0700 | [diff] [blame] | 35 | struct _PyArg_Parser *parser, ...); |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 36 | PyAPI_FUNC(int) _PyArg_ParseTuple_SizeT(PyObject *, const char *, ...); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 37 | PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywords_SizeT(PyObject *, PyObject *, |
| 38 | const char *, char **, ...); |
| 39 | PyAPI_FUNC(PyObject *) _Py_BuildValue_SizeT(const char *, ...); |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 40 | PyAPI_FUNC(int) _PyArg_VaParse_SizeT(PyObject *, const char *, va_list); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 41 | PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *, PyObject *, |
| 42 | const char *, char **, va_list); |
Benjamin Peterson | 4eef505 | 2016-09-10 17:04:36 -0700 | [diff] [blame] | 43 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 44 | PyAPI_FUNC(int) _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *, |
| 45 | struct _PyArg_Parser *, ...); |
| 46 | PyAPI_FUNC(int) _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *, PyObject *, |
| 47 | struct _PyArg_Parser *, va_list); |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 48 | #endif |
| 49 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 50 | #define FLAG_COMPAT 1 |
| 51 | #define FLAG_SIZE_T 2 |
| 52 | |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 53 | typedef 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 | */ |
| 60 | typedef struct { |
| 61 | void *item; |
| 62 | destr_t destructor; |
| 63 | } freelistentry_t; |
| 64 | |
| 65 | typedef struct { |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 66 | freelistentry_t *entries; |
Antoine Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 67 | int first_available; |
| 68 | int entries_malloced; |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 69 | } freelist_t; |
| 70 | |
Antoine Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 71 | #define STATIC_FREELIST_ENTRIES 8 |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 72 | |
| 73 | /* Forward */ |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 74 | static int vgetargs1_impl(PyObject *args, PyObject *const *stack, Py_ssize_t nargs, |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 75 | const char *format, va_list *p_va, int flags); |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 76 | static int vgetargs1(PyObject *, const char *, va_list *, int); |
Victor Stinner | 84bb1cf | 2013-05-17 00:12:04 +0200 | [diff] [blame] | 77 | static void seterror(Py_ssize_t, const char *, int *, const char *, const char *); |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 78 | static const char *convertitem(PyObject *, const char **, va_list *, int, int *, |
| 79 | char *, size_t, freelist_t *); |
| 80 | static const char *converttuple(PyObject *, const char **, va_list *, int, |
| 81 | int *, char *, size_t, int, freelist_t *); |
| 82 | static const char *convertsimple(PyObject *, const char **, va_list *, int, |
| 83 | char *, size_t, freelist_t *); |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 84 | static Py_ssize_t convertbuffer(PyObject *, const void **p, const char **); |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 85 | static int getbuffer(PyObject *, Py_buffer *, const char**); |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 86 | |
Tim Peters | dbd9ba6 | 2000-07-09 03:09:57 +0000 | [diff] [blame] | 87 | static int vgetargskeywords(PyObject *, PyObject *, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 88 | const char *, char **, va_list *, int); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 89 | static int vgetargskeywordsfast(PyObject *, PyObject *, |
| 90 | struct _PyArg_Parser *, va_list *, int); |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 91 | static int vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs, |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 92 | PyObject *keywords, PyObject *kwnames, |
| 93 | struct _PyArg_Parser *parser, |
| 94 | va_list *p_va, int flags); |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 95 | static const char *skipitem(const char **, va_list *, int); |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 96 | |
Fred Drake | 563dfc2 | 2001-10-23 14:41:08 +0000 | [diff] [blame] | 97 | int |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 98 | PyArg_Parse(PyObject *args, const char *format, ...) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 99 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 100 | int retval; |
| 101 | va_list va; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 102 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 103 | va_start(va, format); |
| 104 | retval = vgetargs1(args, format, &va, FLAG_COMPAT); |
| 105 | va_end(va); |
| 106 | return retval; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 107 | } |
| 108 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 109 | PyAPI_FUNC(int) |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 110 | _PyArg_Parse_SizeT(PyObject *args, const char *format, ...) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 111 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 112 | int retval; |
| 113 | va_list va; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 114 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 115 | va_start(va, format); |
| 116 | retval = vgetargs1(args, format, &va, FLAG_COMPAT|FLAG_SIZE_T); |
| 117 | va_end(va); |
| 118 | return retval; |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 119 | } |
| 120 | |
| 121 | |
Fred Drake | 563dfc2 | 2001-10-23 14:41:08 +0000 | [diff] [blame] | 122 | int |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 123 | PyArg_ParseTuple(PyObject *args, const char *format, ...) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 124 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 125 | int retval; |
| 126 | va_list va; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 127 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 128 | va_start(va, format); |
| 129 | retval = vgetargs1(args, format, &va, 0); |
| 130 | va_end(va); |
| 131 | return retval; |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 132 | } |
| 133 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 134 | PyAPI_FUNC(int) |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 135 | _PyArg_ParseTuple_SizeT(PyObject *args, const char *format, ...) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 136 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 137 | int retval; |
| 138 | va_list va; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 139 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 140 | va_start(va, format); |
| 141 | retval = vgetargs1(args, format, &va, FLAG_SIZE_T); |
| 142 | va_end(va); |
| 143 | return retval; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 144 | } |
| 145 | |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 146 | |
| 147 | int |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 148 | _PyArg_ParseStack(PyObject *const *args, Py_ssize_t nargs, const char *format, ...) |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 149 | { |
| 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 Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 159 | PyAPI_FUNC(int) |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 160 | _PyArg_ParseStack_SizeT(PyObject *const *args, Py_ssize_t nargs, const char *format, ...) |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 161 | { |
| 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 | |
| 172 | int |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 173 | PyArg_VaParse(PyObject *args, const char *format, va_list va) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 174 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 175 | va_list lva; |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 176 | int retval; |
Guido van Rossum | 1ae940a | 1995-01-02 19:04:15 +0000 | [diff] [blame] | 177 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 178 | va_copy(lva, va); |
Guido van Rossum | 1ae940a | 1995-01-02 19:04:15 +0000 | [diff] [blame] | 179 | |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 180 | retval = vgetargs1(args, format, &lva, 0); |
| 181 | va_end(lva); |
| 182 | return retval; |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 183 | } |
| 184 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 185 | PyAPI_FUNC(int) |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 186 | _PyArg_VaParse_SizeT(PyObject *args, const char *format, va_list va) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 187 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 188 | va_list lva; |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 189 | int retval; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 190 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 191 | va_copy(lva, va); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 192 | |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 193 | retval = vgetargs1(args, format, &lva, FLAG_SIZE_T); |
| 194 | va_end(lva); |
| 195 | return retval; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 196 | } |
| 197 | |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 198 | |
Martin v. Löwis | e6bbb4d | 2003-05-03 10:00:22 +0000 | [diff] [blame] | 199 | /* Handle cleanup of allocated memory in case of exception */ |
| 200 | |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 201 | static int |
| 202 | cleanup_ptr(PyObject *self, void *ptr) |
Antoine Pitrou | f7199578 | 2008-08-29 18:37:05 +0000 | [diff] [blame] | 203 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 204 | if (ptr) { |
Victor Stinner | 00d7abd | 2020-12-01 09:56:42 +0100 | [diff] [blame] | 205 | PyMem_Free(ptr); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 206 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 207 | return 0; |
Martin v. Löwis | c15bdef | 2009-05-29 14:47:46 +0000 | [diff] [blame] | 208 | } |
| 209 | |
Martin v. Löwis | e6bbb4d | 2003-05-03 10:00:22 +0000 | [diff] [blame] | 210 | static int |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 211 | cleanup_buffer(PyObject *self, void *ptr) |
Martin v. Löwis | e6bbb4d | 2003-05-03 10:00:22 +0000 | [diff] [blame] | 212 | { |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 213 | Py_buffer *buf = (Py_buffer *)ptr; |
| 214 | if (buf) { |
| 215 | PyBuffer_Release(buf); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 216 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 217 | return 0; |
| 218 | } |
| 219 | |
| 220 | static int |
| 221 | addcleanup(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 | |
| 234 | static int |
| 235 | cleanreturn(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 Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 248 | if (freelist->entries_malloced) |
Victor Stinner | 00d7abd | 2020-12-01 09:56:42 +0100 | [diff] [blame] | 249 | PyMem_Free(freelist->entries); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 250 | return retval; |
Martin v. Löwis | e6bbb4d | 2003-05-03 10:00:22 +0000 | [diff] [blame] | 251 | } |
| 252 | |
| 253 | |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 254 | static int |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 255 | vgetargs1_impl(PyObject *compat_args, PyObject *const *stack, Py_ssize_t nargs, const char *format, |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 256 | va_list *p_va, int flags) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 257 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 258 | 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 Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 267 | Py_ssize_t i; |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 268 | const char *msg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 269 | int compat = flags & FLAG_COMPAT; |
Benjamin Peterson | 40be9e5 | 2014-02-11 10:09:27 -0500 | [diff] [blame] | 270 | freelistentry_t static_entries[STATIC_FREELIST_ENTRIES]; |
| 271 | freelist_t freelist; |
| 272 | |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 273 | assert(nargs == 0 || stack != NULL); |
| 274 | |
Benjamin Peterson | 40be9e5 | 2014-02-11 10:09:27 -0500 | [diff] [blame] | 275 | freelist.entries = static_entries; |
| 276 | freelist.first_available = 0; |
| 277 | freelist.entries_malloced = 0; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 278 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 279 | flags = flags & ~FLAG_COMPAT; |
Tim Peters | 5c4d5bf | 2001-02-12 22:13:26 +0000 | [diff] [blame] | 280 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 281 | 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 Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 309 | case '|': |
| 310 | if (level == 0) |
| 311 | min = max; |
| 312 | break; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 313 | default: |
| 314 | if (level == 0) { |
Jordon Xu | 2ec7010 | 2019-09-11 00:04:08 +0800 | [diff] [blame] | 315 | if (Py_ISALPHA(c)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 316 | if (c != 'e') /* skip encoded */ |
| 317 | max++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 318 | } |
| 319 | break; |
| 320 | } |
| 321 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 322 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 323 | if (level != 0) |
| 324 | Py_FatalError(/* '(' */ "missing ')' in getargs format"); |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 325 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 326 | if (min < 0) |
| 327 | min = max; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 328 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 329 | format = formatsave; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 330 | |
Antoine Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 331 | 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 Peterson | 7ed6727 | 2012-03-16 12:21:02 -0500 | [diff] [blame] | 338 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 339 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 340 | if (compat) { |
| 341 | if (max == 0) { |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 342 | if (compat_args == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 343 | return 1; |
Victor Stinner | 6ced7c4 | 2011-03-21 18:15:42 +0100 | [diff] [blame] | 344 | PyErr_Format(PyExc_TypeError, |
| 345 | "%.200s%s takes no arguments", |
| 346 | fname==NULL ? "function" : fname, |
| 347 | fname==NULL ? "" : "()"); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 348 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 349 | } |
| 350 | else if (min == 1 && max == 1) { |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 351 | if (compat_args == NULL) { |
Victor Stinner | 6ced7c4 | 2011-03-21 18:15:42 +0100 | [diff] [blame] | 352 | PyErr_Format(PyExc_TypeError, |
| 353 | "%.200s%s takes at least one argument", |
| 354 | fname==NULL ? "function" : fname, |
| 355 | fname==NULL ? "" : "()"); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 356 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 357 | } |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 358 | msg = convertitem(compat_args, &format, p_va, flags, levels, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 359 | msgbuf, sizeof(msgbuf), &freelist); |
| 360 | if (msg == NULL) |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 361 | return cleanreturn(1, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 362 | seterror(levels[0], msg, levels+1, fname, message); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 363 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 364 | } |
| 365 | else { |
| 366 | PyErr_SetString(PyExc_SystemError, |
| 367 | "old style getargs format uses new features"); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 368 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 369 | } |
| 370 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 371 | |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 372 | if (nargs < min || max < nargs) { |
Victor Stinner | 6ced7c4 | 2011-03-21 18:15:42 +0100 | [diff] [blame] | 373 | if (message == NULL) |
| 374 | PyErr_Format(PyExc_TypeError, |
Serhiy Storchaka | d53fe5f | 2019-03-13 22:59:55 +0200 | [diff] [blame] | 375 | "%.150s%s takes %s %d argument%s (%zd given)", |
Victor Stinner | 6ced7c4 | 2011-03-21 18:15:42 +0100 | [diff] [blame] | 376 | fname==NULL ? "function" : fname, |
| 377 | fname==NULL ? "" : "()", |
| 378 | min==max ? "exactly" |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 379 | : nargs < min ? "at least" : "at most", |
| 380 | nargs < min ? min : max, |
| 381 | (nargs < min ? min : max) == 1 ? "" : "s", |
Serhiy Storchaka | d53fe5f | 2019-03-13 22:59:55 +0200 | [diff] [blame] | 382 | nargs); |
Victor Stinner | 6ced7c4 | 2011-03-21 18:15:42 +0100 | [diff] [blame] | 383 | else |
| 384 | PyErr_SetString(PyExc_TypeError, message); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 385 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 386 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 387 | |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 388 | for (i = 0; i < nargs; i++) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 389 | if (*format == '|') |
| 390 | format++; |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 391 | msg = convertitem(stack[i], &format, p_va, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 392 | flags, levels, msgbuf, |
| 393 | sizeof(msgbuf), &freelist); |
| 394 | if (msg) { |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 395 | seterror(i+1, msg, levels, fname, message); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 396 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 397 | } |
| 398 | } |
Guido van Rossum | 231a41e | 1997-12-09 20:36:39 +0000 | [diff] [blame] | 399 | |
Jordon Xu | 2ec7010 | 2019-09-11 00:04:08 +0800 | [diff] [blame] | 400 | if (*format != '\0' && !Py_ISALPHA(*format) && |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 401 | *format != '(' && |
| 402 | *format != '|' && *format != ':' && *format != ';') { |
| 403 | PyErr_Format(PyExc_SystemError, |
| 404 | "bad format string: %.200s", formatsave); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 405 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 406 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 407 | |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 408 | return cleanreturn(1, &freelist); |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 409 | } |
| 410 | |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 411 | static int |
| 412 | vgetargs1(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 Stinner | d17a693 | 2018-11-09 16:56:48 +0100 | [diff] [blame] | 426 | stack = _PyTuple_ITEMS(args); |
Victor Stinner | 6518a93 | 2017-01-17 01:29:49 +0100 | [diff] [blame] | 427 | 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 Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 436 | |
| 437 | |
| 438 | static void |
Victor Stinner | 84bb1cf | 2013-05-17 00:12:04 +0200 | [diff] [blame] | 439 | seterror(Py_ssize_t iarg, const char *msg, int *levels, const char *fname, |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 440 | const char *message) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 441 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 442 | char buf[512]; |
| 443 | int i; |
| 444 | char *p = buf; |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 445 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 446 | 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 Stinner | d36cf5f | 2020-06-10 18:38:05 +0200 | [diff] [blame] | 455 | "argument %zd", iarg); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 456 | i = 0; |
| 457 | p += strlen(p); |
Georg Brandl | 142ad66 | 2013-10-14 07:01:11 +0200 | [diff] [blame] | 458 | while (i < 32 && levels[i] > 0 && (int)(p-buf) < 220) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 459 | 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 Storchaka | 4cd63ef | 2016-02-08 01:22:47 +0200 | [diff] [blame] | 472 | if (msg[0] == '(') { |
| 473 | PyErr_SetString(PyExc_SystemError, message); |
| 474 | } |
| 475 | else { |
| 476 | PyErr_SetString(PyExc_TypeError, message); |
| 477 | } |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 478 | } |
| 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 493 | "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 Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 496 | and msgbuf is returned. |
| 497 | */ |
| 498 | |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 499 | static const char * |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 500 | converttuple(PyObject *arg, const char **p_format, va_list *p_va, int flags, |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 501 | int *levels, char *msgbuf, size_t bufsize, int toplevel, |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 502 | freelist_t *freelist) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 503 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 504 | int level = 0; |
| 505 | int n = 0; |
| 506 | const char *format = *p_format; |
| 507 | int i; |
Victor Stinner | 74387f5 | 2013-11-18 01:21:12 +0100 | [diff] [blame] | 508 | Py_ssize_t len; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 509 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 510 | 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 Xu | 2ec7010 | 2019-09-11 00:04:08 +0800 | [diff] [blame] | 524 | else if (level == 0 && Py_ISALPHA(c)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 525 | n++; |
| 526 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 527 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 528 | 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 Stinner | a102ed7 | 2020-02-07 02:24:48 +0100 | [diff] [blame] | 534 | arg == Py_None ? "None" : Py_TYPE(arg)->tp_name); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 535 | return msgbuf; |
| 536 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 537 | |
Victor Stinner | 74387f5 | 2013-11-18 01:21:12 +0100 | [diff] [blame] | 538 | len = PySequence_Size(arg); |
| 539 | if (len != n) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 540 | levels[0] = 0; |
Victor Stinner | 74387f5 | 2013-11-18 01:21:12 +0100 | [diff] [blame] | 541 | if (toplevel) { |
| 542 | PyOS_snprintf(msgbuf, bufsize, |
Victor Stinner | d36cf5f | 2020-06-10 18:38:05 +0200 | [diff] [blame] | 543 | "expected %d argument%s, not %zd", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 544 | n, |
| 545 | n == 1 ? "" : "s", |
| 546 | len); |
Victor Stinner | 74387f5 | 2013-11-18 01:21:12 +0100 | [diff] [blame] | 547 | } |
| 548 | else { |
| 549 | PyOS_snprintf(msgbuf, bufsize, |
Victor Stinner | d36cf5f | 2020-06-10 18:38:05 +0200 | [diff] [blame] | 550 | "must be sequence of length %d, not %zd", |
Victor Stinner | 74387f5 | 2013-11-18 01:21:12 +0100 | [diff] [blame] | 551 | n, len); |
| 552 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 553 | return msgbuf; |
| 554 | } |
Ka-Ping Yee | 2057970 | 2001-01-15 22:14:16 +0000 | [diff] [blame] | 555 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 556 | format = *p_format; |
| 557 | for (i = 0; i < n; i++) { |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 558 | const char *msg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 559 | 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 Yee | 2057970 | 2001-01-15 22:14:16 +0000 | [diff] [blame] | 577 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 578 | *p_format = format; |
| 579 | return NULL; |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 580 | } |
| 581 | |
| 582 | |
| 583 | /* Convert a single item. */ |
| 584 | |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 585 | static const char * |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 586 | convertitem(PyObject *arg, const char **p_format, va_list *p_va, int flags, |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 587 | int *levels, char *msgbuf, size_t bufsize, freelist_t *freelist) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 588 | { |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 589 | const char *msg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 590 | const char *format = *p_format; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 591 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 592 | 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 Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 608 | } |
| 609 | |
| 610 | |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 611 | |
Rémi Lapeyre | 4901fe2 | 2019-08-29 16:49:08 +0200 | [diff] [blame] | 612 | /* Format an error message generated by convertsimple(). |
| 613 | displayname must be UTF-8 encoded. |
| 614 | */ |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 615 | |
Serhiy Storchaka | 32d96a2 | 2018-12-25 13:23:47 +0200 | [diff] [blame] | 616 | void |
Rémi Lapeyre | 4901fe2 | 2019-08-29 16:49:08 +0200 | [diff] [blame] | 617 | _PyArg_BadArgument(const char *fname, const char *displayname, |
Serhiy Storchaka | 4fa9591 | 2019-01-11 16:01:14 +0200 | [diff] [blame] | 618 | const char *expected, PyObject *arg) |
Serhiy Storchaka | 32d96a2 | 2018-12-25 13:23:47 +0200 | [diff] [blame] | 619 | { |
Rémi Lapeyre | 4901fe2 | 2019-08-29 16:49:08 +0200 | [diff] [blame] | 620 | PyErr_Format(PyExc_TypeError, |
| 621 | "%.200s() %.200s must be %.50s, not %.50s", |
| 622 | fname, displayname, expected, |
Victor Stinner | a102ed7 | 2020-02-07 02:24:48 +0100 | [diff] [blame] | 623 | arg == Py_None ? "None" : Py_TYPE(arg)->tp_name); |
Serhiy Storchaka | 32d96a2 | 2018-12-25 13:23:47 +0200 | [diff] [blame] | 624 | } |
| 625 | |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 626 | static const char * |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 627 | converterr(const char *expected, PyObject *arg, char *msgbuf, size_t bufsize) |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 628 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 629 | assert(expected != NULL); |
| 630 | assert(arg != NULL); |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 631 | 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 Stinner | a102ed7 | 2020-02-07 02:24:48 +0100 | [diff] [blame] | 638 | arg == Py_None ? "None" : Py_TYPE(arg)->tp_name); |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 639 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 640 | return msgbuf; |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 641 | } |
| 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 Brandl | 6dd1461 | 2005-09-14 19:29:53 +0000 | [diff] [blame] | 649 | Don't call if a tuple is expected. |
| 650 | |
| 651 | When you add new format codes, please don't forget poor skipitem() below. |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 652 | */ |
| 653 | |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 654 | static const char * |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 655 | convertsimple(PyObject *arg, const char **p_format, va_list *p_va, int flags, |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 656 | char *msgbuf, size_t bufsize, freelist_t *freelist) |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 657 | { |
Inada Naoki | c71d24f | 2021-02-27 20:31:03 +0900 | [diff] [blame] | 658 | #define RETURN_ERR_OCCURRED return msgbuf |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 659 | /* For # codes */ |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 660 | #define REQUIRE_PY_SSIZE_T_CLEAN \ |
| 661 | if (!(flags & FLAG_SIZE_T)) { \ |
| 662 | PyErr_SetString(PyExc_SystemError, \ |
| 663 | "PY_SSIZE_T_CLEAN macro must be defined for '#' formats"); \ |
Inada Naoki | c71d24f | 2021-02-27 20:31:03 +0900 | [diff] [blame] | 664 | RETURN_ERR_OCCURRED; \ |
Inada Naoki | d3c72a2 | 2019-03-23 21:04:40 +0900 | [diff] [blame] | 665 | } |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 666 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 667 | const char *format = *p_format; |
| 668 | char c = *format++; |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 669 | const char *sarg; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 670 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 671 | switch (c) { |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 672 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 673 | case 'b': { /* unsigned byte -- very short int */ |
| 674 | char *p = va_arg(*p_va, char *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 675 | long ival = PyLong_AsLong(arg); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 676 | if (ival == -1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 677 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 678 | else if (ival < 0) { |
| 679 | PyErr_SetString(PyExc_OverflowError, |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 680 | "unsigned byte integer is less than minimum"); |
| 681 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 682 | } |
| 683 | else if (ival > UCHAR_MAX) { |
| 684 | PyErr_SetString(PyExc_OverflowError, |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 685 | "unsigned byte integer is greater than maximum"); |
| 686 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 687 | } |
| 688 | else |
| 689 | *p = (unsigned char) ival; |
| 690 | break; |
| 691 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 692 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 693 | case 'B': {/* byte sized bitfield - both signed and unsigned |
| 694 | values allowed */ |
| 695 | char *p = va_arg(*p_va, char *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 696 | unsigned long ival = PyLong_AsUnsignedLongMask(arg); |
| 697 | if (ival == (unsigned long)-1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 698 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 699 | else |
| 700 | *p = (unsigned char) ival; |
| 701 | break; |
| 702 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 703 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 704 | case 'h': {/* signed short int */ |
| 705 | short *p = va_arg(*p_va, short *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 706 | long ival = PyLong_AsLong(arg); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 707 | if (ival == -1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 708 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 709 | else if (ival < SHRT_MIN) { |
| 710 | PyErr_SetString(PyExc_OverflowError, |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 711 | "signed short integer is less than minimum"); |
| 712 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 713 | } |
| 714 | else if (ival > SHRT_MAX) { |
| 715 | PyErr_SetString(PyExc_OverflowError, |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 716 | "signed short integer is greater than maximum"); |
| 717 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 718 | } |
| 719 | else |
| 720 | *p = (short) ival; |
| 721 | break; |
| 722 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 723 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 724 | case 'H': { /* short int sized bitfield, both signed and |
| 725 | unsigned allowed */ |
| 726 | unsigned short *p = va_arg(*p_va, unsigned short *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 727 | unsigned long ival = PyLong_AsUnsignedLongMask(arg); |
| 728 | if (ival == (unsigned long)-1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 729 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 730 | else |
| 731 | *p = (unsigned short) ival; |
| 732 | break; |
| 733 | } |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 734 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 735 | case 'i': {/* signed int */ |
| 736 | int *p = va_arg(*p_va, int *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 737 | long ival = PyLong_AsLong(arg); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 738 | if (ival == -1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 739 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 740 | else if (ival > INT_MAX) { |
| 741 | PyErr_SetString(PyExc_OverflowError, |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 742 | "signed integer is greater than maximum"); |
| 743 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 744 | } |
| 745 | else if (ival < INT_MIN) { |
| 746 | PyErr_SetString(PyExc_OverflowError, |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 747 | "signed integer is less than minimum"); |
| 748 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 749 | } |
| 750 | else |
| 751 | *p = ival; |
| 752 | break; |
| 753 | } |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 754 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 755 | case 'I': { /* int sized bitfield, both signed and |
| 756 | unsigned allowed */ |
| 757 | unsigned int *p = va_arg(*p_va, unsigned int *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 758 | unsigned long ival = PyLong_AsUnsignedLongMask(arg); |
| 759 | if (ival == (unsigned long)-1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 760 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 761 | else |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 762 | *p = (unsigned int) ival; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 763 | break; |
| 764 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 765 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 766 | 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 Storchaka | 5f4b229d | 2020-05-28 10:33:45 +0300 | [diff] [blame] | 771 | iobj = _PyNumber_Index(arg); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 772 | if (iobj != NULL) { |
| 773 | ival = PyLong_AsSsize_t(iobj); |
| 774 | Py_DECREF(iobj); |
| 775 | } |
| 776 | if (ival == -1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 777 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 778 | *p = ival; |
| 779 | break; |
| 780 | } |
| 781 | case 'l': {/* long int */ |
| 782 | long *p = va_arg(*p_va, long *); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 783 | long ival = PyLong_AsLong(arg); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 784 | if (ival == -1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 785 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 786 | else |
| 787 | *p = ival; |
| 788 | break; |
| 789 | } |
Thomas Heller | a4ea603 | 2003-04-17 18:55:45 +0000 | [diff] [blame] | 790 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 791 | 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 Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 797 | return converterr("int", arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 798 | *p = ival; |
| 799 | break; |
| 800 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 801 | |
Benjamin Peterson | af580df | 2016-09-06 10:46:49 -0700 | [diff] [blame] | 802 | case 'L': {/* long long */ |
| 803 | long long *p = va_arg( *p_va, long long * ); |
Serhiy Storchaka | 578c395 | 2020-05-26 18:43:38 +0300 | [diff] [blame] | 804 | long long ival = PyLong_AsLongLong(arg); |
Benjamin Peterson | af580df | 2016-09-06 10:46:49 -0700 | [diff] [blame] | 805 | if (ival == (long long)-1 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 806 | RETURN_ERR_OCCURRED; |
Mark Dickinson | c730131 | 2010-06-10 16:05:10 +0000 | [diff] [blame] | 807 | else |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 808 | *p = ival; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 809 | break; |
| 810 | } |
Thomas Heller | a4ea603 | 2003-04-17 18:55:45 +0000 | [diff] [blame] | 811 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 812 | case 'K': { /* long long sized bitfield */ |
Benjamin Peterson | af580df | 2016-09-06 10:46:49 -0700 | [diff] [blame] | 813 | unsigned long long *p = va_arg(*p_va, unsigned long long *); |
| 814 | unsigned long long ival; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 815 | if (PyLong_Check(arg)) |
| 816 | ival = PyLong_AsUnsignedLongLongMask(arg); |
| 817 | else |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 818 | return converterr("int", arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 819 | *p = ival; |
| 820 | break; |
| 821 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 822 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 823 | case 'f': {/* float */ |
| 824 | float *p = va_arg(*p_va, float *); |
| 825 | double dval = PyFloat_AsDouble(arg); |
Raymond Hettinger | aef9ad8 | 2019-08-24 19:10:39 -0700 | [diff] [blame] | 826 | if (dval == -1.0 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 827 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 828 | else |
| 829 | *p = (float) dval; |
| 830 | break; |
| 831 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 832 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 833 | case 'd': {/* double */ |
| 834 | double *p = va_arg(*p_va, double *); |
| 835 | double dval = PyFloat_AsDouble(arg); |
Raymond Hettinger | aef9ad8 | 2019-08-24 19:10:39 -0700 | [diff] [blame] | 836 | if (dval == -1.0 && PyErr_Occurred()) |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 837 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 838 | else |
| 839 | *p = dval; |
| 840 | break; |
| 841 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 842 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 843 | 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 Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 848 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 849 | else |
| 850 | *p = cval; |
| 851 | break; |
| 852 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 853 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 854 | 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 Bendersky | 906b88f | 2011-07-29 07:05:08 +0300 | [diff] [blame] | 858 | else if (PyByteArray_Check(arg) && PyByteArray_Size(arg) == 1) |
| 859 | *p = PyByteArray_AS_STRING(arg)[0]; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 860 | else |
| 861 | return converterr("a byte string of length 1", arg, msgbuf, bufsize); |
| 862 | break; |
| 863 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 864 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 865 | case 'C': {/* unicode char */ |
| 866 | int *p = va_arg(*p_va, int *); |
Victor Stinner | e1335c7 | 2011-10-04 20:53:03 +0200 | [diff] [blame] | 867 | int kind; |
Serhiy Storchaka | cd8295f | 2020-04-11 10:48:40 +0300 | [diff] [blame] | 868 | const void *data; |
Victor Stinner | e1335c7 | 2011-10-04 20:53:03 +0200 | [diff] [blame] | 869 | |
| 870 | if (!PyUnicode_Check(arg)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 871 | return converterr("a unicode character", arg, msgbuf, bufsize); |
Victor Stinner | e1335c7 | 2011-10-04 20:53:03 +0200 | [diff] [blame] | 872 | |
| 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 Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 882 | break; |
| 883 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 884 | |
Larry Hastings | faf91e7 | 2012-05-05 16:54:29 -0700 | [diff] [blame] | 885 | 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 Stinner | 3dcb5ac | 2010-06-08 22:54:19 +0000 | [diff] [blame] | 897 | /* XXX WAAAAH! 's', 'y', 'z', 'u', 'Z', 'e', 'w' codes all |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 898 | need to be cleaned up! */ |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 899 | |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 900 | case 'y': {/* any bytes-like object */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 901 | void **p = (void **)va_arg(*p_va, char **); |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 902 | const char *buf; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 903 | 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 Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 908 | if (addcleanup(p, freelist, cleanup_buffer)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 909 | return converterr( |
| 910 | "(cleanup problem)", |
| 911 | arg, msgbuf, bufsize); |
| 912 | } |
| 913 | break; |
| 914 | } |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 915 | count = convertbuffer(arg, (const void **)p, &buf); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 916 | if (count < 0) |
| 917 | return converterr(buf, arg, msgbuf, bufsize); |
Victor Stinner | 06e49dd | 2010-06-13 18:21:50 +0000 | [diff] [blame] | 918 | if (*format == '#') { |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 919 | REQUIRE_PY_SSIZE_T_CLEAN; |
| 920 | Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*); |
| 921 | *psize = count; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 922 | format++; |
Victor Stinner | 06e49dd | 2010-06-13 18:21:50 +0000 | [diff] [blame] | 923 | } else { |
Serhiy Storchaka | d8a1447 | 2014-09-06 20:07:17 +0300 | [diff] [blame] | 924 | if (strlen(*p) != (size_t)count) { |
| 925 | PyErr_SetString(PyExc_ValueError, "embedded null byte"); |
| 926 | RETURN_ERR_OCCURRED; |
| 927 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 928 | } |
| 929 | break; |
| 930 | } |
Walter Dörwald | 612344f | 2007-05-04 19:28:21 +0000 | [diff] [blame] | 931 | |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 932 | case 's': /* text string or bytes-like object */ |
| 933 | case 'z': /* text string, bytes-like object or None */ |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 934 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 935 | if (*format == '*') { |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 936 | /* "s*" or "z*" */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 937 | Py_buffer *p = (Py_buffer *)va_arg(*p_va, Py_buffer *); |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 938 | |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 939 | if (c == 'z' && arg == Py_None) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 940 | PyBuffer_FillInfo(p, NULL, NULL, 0, 1, 0); |
| 941 | else if (PyUnicode_Check(arg)) { |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 942 | Py_ssize_t len; |
| 943 | sarg = PyUnicode_AsUTF8AndSize(arg, &len); |
| 944 | if (sarg == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 945 | return converterr(CONV_UNICODE, |
| 946 | arg, msgbuf, bufsize); |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 947 | PyBuffer_FillInfo(p, arg, (void *)sarg, len, 1, 0); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 948 | } |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 949 | else { /* any bytes-like object */ |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 950 | const char *buf; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 951 | if (getbuffer(arg, p, &buf) < 0) |
| 952 | return converterr(buf, arg, msgbuf, bufsize); |
| 953 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 954 | if (addcleanup(p, freelist, cleanup_buffer)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 955 | return converterr( |
| 956 | "(cleanup problem)", |
| 957 | arg, msgbuf, bufsize); |
| 958 | } |
| 959 | format++; |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 960 | } else if (*format == '#') { /* a string or read-only bytes-like object */ |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 961 | /* "s#" or "z#" */ |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 962 | const void **p = (const void **)va_arg(*p_va, const char **); |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 963 | REQUIRE_PY_SSIZE_T_CLEAN; |
| 964 | Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*); |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 965 | |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 966 | if (c == 'z' && arg == Py_None) { |
| 967 | *p = NULL; |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 968 | *psize = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 969 | } |
| 970 | else if (PyUnicode_Check(arg)) { |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 971 | Py_ssize_t len; |
| 972 | sarg = PyUnicode_AsUTF8AndSize(arg, &len); |
| 973 | if (sarg == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 974 | return converterr(CONV_UNICODE, |
| 975 | arg, msgbuf, bufsize); |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 976 | *p = sarg; |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 977 | *psize = len; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 978 | } |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 979 | else { /* read-only bytes-like object */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 980 | /* XXX Really? */ |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 981 | const char *buf; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 982 | Py_ssize_t count = convertbuffer(arg, p, &buf); |
| 983 | if (count < 0) |
| 984 | return converterr(buf, arg, msgbuf, bufsize); |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 985 | *psize = count; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 986 | } |
| 987 | format++; |
| 988 | } else { |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 989 | /* "s" or "z" */ |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 990 | const char **p = va_arg(*p_va, const char **); |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 991 | Py_ssize_t len; |
| 992 | sarg = NULL; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 993 | |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 994 | if (c == 'z' && arg == Py_None) |
| 995 | *p = NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 996 | else if (PyUnicode_Check(arg)) { |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 997 | sarg = PyUnicode_AsUTF8AndSize(arg, &len); |
| 998 | if (sarg == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 999 | return converterr(CONV_UNICODE, |
| 1000 | arg, msgbuf, bufsize); |
Serhiy Storchaka | d8a1447 | 2014-09-06 20:07:17 +0300 | [diff] [blame] | 1001 | if (strlen(sarg) != (size_t)len) { |
| 1002 | PyErr_SetString(PyExc_ValueError, "embedded null character"); |
| 1003 | RETURN_ERR_OCCURRED; |
| 1004 | } |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 1005 | *p = sarg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1006 | } |
| 1007 | else |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 1008 | return converterr(c == 'z' ? "str or None" : "str", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1009 | arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1010 | } |
| 1011 | break; |
| 1012 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1013 | |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 1014 | case 'u': /* raw unicode buffer (Py_UNICODE *) */ |
| 1015 | case 'Z': /* raw unicode buffer or None */ |
| 1016 | { |
Inada Naoki | 91a639a | 2021-02-22 22:11:48 +0900 | [diff] [blame] | 1017 | if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1, |
| 1018 | "getargs: The '%c' format is deprecated. Use 'U' instead.", c)) { |
| 1019 | return NULL; |
| 1020 | } |
Inada Naoki | 2c4928d | 2020-06-17 20:09:44 +0900 | [diff] [blame] | 1021 | _Py_COMP_DIAG_PUSH |
| 1022 | _Py_COMP_DIAG_IGNORE_DEPR_DECLS |
Brett Cannon | b94767f | 2011-02-22 20:15:44 +0000 | [diff] [blame] | 1023 | Py_UNICODE **p = va_arg(*p_va, Py_UNICODE **); |
| 1024 | |
Serhiy Storchaka | b757c83 | 2014-12-05 22:25:22 +0200 | [diff] [blame] | 1025 | if (*format == '#') { |
Serhiy Storchaka | d6e53da | 2015-04-19 21:11:30 +0300 | [diff] [blame] | 1026 | /* "u#" or "Z#" */ |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1027 | REQUIRE_PY_SSIZE_T_CLEAN; |
| 1028 | Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*); |
Travis E. Oliphant | ddacf96 | 2007-10-13 21:03:27 +0000 | [diff] [blame] | 1029 | |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 1030 | if (c == 'Z' && arg == Py_None) { |
| 1031 | *p = NULL; |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1032 | *psize = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1033 | } |
| 1034 | else if (PyUnicode_Check(arg)) { |
Victor Stinner | beac78b | 2011-10-11 21:55:01 +0200 | [diff] [blame] | 1035 | Py_ssize_t len; |
| 1036 | *p = PyUnicode_AsUnicodeAndSize(arg, &len); |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 1037 | if (*p == NULL) |
| 1038 | RETURN_ERR_OCCURRED; |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1039 | *psize = len; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1040 | } |
Victor Stinner | 5216e6d | 2010-06-08 21:45:51 +0000 | [diff] [blame] | 1041 | else |
Serhiy Storchaka | d6e53da | 2015-04-19 21:11:30 +0300 | [diff] [blame] | 1042 | return converterr(c == 'Z' ? "str or None" : "str", |
| 1043 | arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1044 | format++; |
| 1045 | } else { |
Serhiy Storchaka | d6e53da | 2015-04-19 21:11:30 +0300 | [diff] [blame] | 1046 | /* "u" or "Z" */ |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 1047 | if (c == 'Z' && arg == Py_None) |
| 1048 | *p = NULL; |
Victor Stinner | 06e49dd | 2010-06-13 18:21:50 +0000 | [diff] [blame] | 1049 | else if (PyUnicode_Check(arg)) { |
Victor Stinner | beac78b | 2011-10-11 21:55:01 +0200 | [diff] [blame] | 1050 | Py_ssize_t len; |
| 1051 | *p = PyUnicode_AsUnicodeAndSize(arg, &len); |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 1052 | if (*p == NULL) |
| 1053 | RETURN_ERR_OCCURRED; |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 1054 | if (wcslen(*p) != (size_t)len) { |
Serhiy Storchaka | d8a1447 | 2014-09-06 20:07:17 +0300 | [diff] [blame] | 1055 | PyErr_SetString(PyExc_ValueError, "embedded null character"); |
| 1056 | RETURN_ERR_OCCURRED; |
| 1057 | } |
Victor Stinner | 06e49dd | 2010-06-13 18:21:50 +0000 | [diff] [blame] | 1058 | } else |
Victor Stinner | 3c9e6e9 | 2010-06-24 22:31:12 +0000 | [diff] [blame] | 1059 | return converterr(c == 'Z' ? "str or None" : "str", |
| 1060 | arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1061 | } |
| 1062 | break; |
Inada Naoki | 2c4928d | 2020-06-17 20:09:44 +0900 | [diff] [blame] | 1063 | _Py_COMP_DIAG_POP |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1064 | } |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 1065 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1066 | case 'e': {/* encoded string */ |
| 1067 | char **buffer; |
| 1068 | const char *encoding; |
| 1069 | PyObject *s; |
| 1070 | int recode_strings; |
| 1071 | Py_ssize_t size; |
| 1072 | const char *ptr; |
Jeremy Hylton | 4819e97 | 2001-10-11 14:40:37 +0000 | [diff] [blame] | 1073 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1074 | /* Get 'e' parameter: the encoding name */ |
| 1075 | encoding = (const char *)va_arg(*p_va, const char *); |
| 1076 | if (encoding == NULL) |
| 1077 | encoding = PyUnicode_GetDefaultEncoding(); |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 1078 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1079 | /* Get output buffer parameter: |
| 1080 | 's' (recode all objects via Unicode) or |
| 1081 | 't' (only recode non-string objects) |
| 1082 | */ |
| 1083 | if (*format == 's') |
| 1084 | recode_strings = 1; |
| 1085 | else if (*format == 't') |
| 1086 | recode_strings = 0; |
| 1087 | else |
| 1088 | return converterr( |
| 1089 | "(unknown parser marker combination)", |
| 1090 | arg, msgbuf, bufsize); |
| 1091 | buffer = (char **)va_arg(*p_va, char **); |
| 1092 | format++; |
| 1093 | if (buffer == NULL) |
| 1094 | return converterr("(buffer is NULL)", |
| 1095 | arg, msgbuf, bufsize); |
Benjamin Peterson | 9edd2bd | 2008-08-27 00:31:37 +0000 | [diff] [blame] | 1096 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1097 | /* Encode object */ |
| 1098 | if (!recode_strings && |
| 1099 | (PyBytes_Check(arg) || PyByteArray_Check(arg))) { |
| 1100 | s = arg; |
| 1101 | Py_INCREF(s); |
Serhiy Storchaka | 460bd0d | 2016-11-20 12:16:46 +0200 | [diff] [blame] | 1102 | if (PyBytes_Check(arg)) { |
| 1103 | size = PyBytes_GET_SIZE(s); |
| 1104 | ptr = PyBytes_AS_STRING(s); |
| 1105 | } |
| 1106 | else { |
| 1107 | size = PyByteArray_GET_SIZE(s); |
| 1108 | ptr = PyByteArray_AS_STRING(s); |
| 1109 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1110 | } |
Serhiy Storchaka | 21a663e | 2016-04-13 15:37:23 +0300 | [diff] [blame] | 1111 | else if (PyUnicode_Check(arg)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1112 | /* Encode object; use default error handling */ |
Serhiy Storchaka | 21a663e | 2016-04-13 15:37:23 +0300 | [diff] [blame] | 1113 | s = PyUnicode_AsEncodedString(arg, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1114 | encoding, |
| 1115 | NULL); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1116 | if (s == NULL) |
| 1117 | return converterr("(encoding failed)", |
| 1118 | arg, msgbuf, bufsize); |
Serhiy Storchaka | 21a663e | 2016-04-13 15:37:23 +0300 | [diff] [blame] | 1119 | assert(PyBytes_Check(s)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1120 | size = PyBytes_GET_SIZE(s); |
| 1121 | ptr = PyBytes_AS_STRING(s); |
| 1122 | if (ptr == NULL) |
| 1123 | ptr = ""; |
| 1124 | } |
Serhiy Storchaka | 21a663e | 2016-04-13 15:37:23 +0300 | [diff] [blame] | 1125 | else { |
| 1126 | return converterr( |
| 1127 | recode_strings ? "str" : "str, bytes or bytearray", |
| 1128 | arg, msgbuf, bufsize); |
| 1129 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1130 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1131 | /* Write output; output is guaranteed to be 0-terminated */ |
| 1132 | if (*format == '#') { |
| 1133 | /* Using buffer length parameter '#': |
| 1134 | |
| 1135 | - if *buffer is NULL, a new buffer of the |
| 1136 | needed size is allocated and the data |
| 1137 | copied into it; *buffer is updated to point |
| 1138 | to the new buffer; the caller is |
| 1139 | responsible for PyMem_Free()ing it after |
| 1140 | usage |
| 1141 | |
| 1142 | - if *buffer is not NULL, the data is |
| 1143 | copied to *buffer; *buffer_len has to be |
| 1144 | set to the size of the buffer on input; |
| 1145 | buffer overflow is signalled with an error; |
| 1146 | buffer has to provide enough room for the |
| 1147 | encoded string plus the trailing 0-byte |
| 1148 | |
| 1149 | - in both cases, *buffer_len is updated to |
| 1150 | the size of the buffer /excluding/ the |
| 1151 | trailing 0-byte |
| 1152 | |
| 1153 | */ |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1154 | REQUIRE_PY_SSIZE_T_CLEAN; |
| 1155 | Py_ssize_t *psize = va_arg(*p_va, Py_ssize_t*); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1156 | |
| 1157 | format++; |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1158 | if (psize == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1159 | Py_DECREF(s); |
| 1160 | return converterr( |
| 1161 | "(buffer_len is NULL)", |
| 1162 | arg, msgbuf, bufsize); |
| 1163 | } |
| 1164 | if (*buffer == NULL) { |
| 1165 | *buffer = PyMem_NEW(char, size + 1); |
| 1166 | if (*buffer == NULL) { |
| 1167 | Py_DECREF(s); |
Victor Stinner | 2872e5b | 2010-06-06 20:38:02 +0000 | [diff] [blame] | 1168 | PyErr_NoMemory(); |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 1169 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1170 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1171 | if (addcleanup(*buffer, freelist, cleanup_ptr)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1172 | Py_DECREF(s); |
| 1173 | return converterr( |
| 1174 | "(cleanup problem)", |
| 1175 | arg, msgbuf, bufsize); |
| 1176 | } |
| 1177 | } else { |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1178 | if (size + 1 > *psize) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1179 | Py_DECREF(s); |
Serhiy Storchaka | 4cd63ef | 2016-02-08 01:22:47 +0200 | [diff] [blame] | 1180 | PyErr_Format(PyExc_ValueError, |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 1181 | "encoded string too long " |
| 1182 | "(%zd, maximum length %zd)", |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1183 | (Py_ssize_t)size, (Py_ssize_t)(*psize - 1)); |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 1184 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1185 | } |
| 1186 | } |
| 1187 | memcpy(*buffer, ptr, size+1); |
Serhiy Storchaka | 5bc6a7c | 2019-10-21 11:35:07 +0300 | [diff] [blame] | 1188 | |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1189 | *psize = size; |
| 1190 | } |
| 1191 | else { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1192 | /* Using a 0-terminated buffer: |
| 1193 | |
| 1194 | - the encoded string has to be 0-terminated |
| 1195 | for this variant to work; if it is not, an |
| 1196 | error raised |
| 1197 | |
| 1198 | - a new buffer of the needed size is |
| 1199 | allocated and the data copied into it; |
| 1200 | *buffer is updated to point to the new |
| 1201 | buffer; the caller is responsible for |
| 1202 | PyMem_Free()ing it after usage |
| 1203 | |
| 1204 | */ |
| 1205 | if ((Py_ssize_t)strlen(ptr) != size) { |
| 1206 | Py_DECREF(s); |
| 1207 | return converterr( |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 1208 | "encoded string without null bytes", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1209 | arg, msgbuf, bufsize); |
| 1210 | } |
| 1211 | *buffer = PyMem_NEW(char, size + 1); |
| 1212 | if (*buffer == NULL) { |
| 1213 | Py_DECREF(s); |
Victor Stinner | 2872e5b | 2010-06-06 20:38:02 +0000 | [diff] [blame] | 1214 | PyErr_NoMemory(); |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 1215 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1216 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1217 | if (addcleanup(*buffer, freelist, cleanup_ptr)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1218 | Py_DECREF(s); |
| 1219 | return converterr("(cleanup problem)", |
| 1220 | arg, msgbuf, bufsize); |
| 1221 | } |
| 1222 | memcpy(*buffer, ptr, size+1); |
| 1223 | } |
| 1224 | Py_DECREF(s); |
| 1225 | break; |
| 1226 | } |
| 1227 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1228 | case 'S': { /* PyBytes object */ |
| 1229 | PyObject **p = va_arg(*p_va, PyObject **); |
| 1230 | if (PyBytes_Check(arg)) |
| 1231 | *p = arg; |
| 1232 | else |
| 1233 | return converterr("bytes", arg, msgbuf, bufsize); |
| 1234 | break; |
| 1235 | } |
| 1236 | |
| 1237 | case 'Y': { /* PyByteArray object */ |
| 1238 | PyObject **p = va_arg(*p_va, PyObject **); |
| 1239 | if (PyByteArray_Check(arg)) |
| 1240 | *p = arg; |
| 1241 | else |
Victor Stinner | 5216e6d | 2010-06-08 21:45:51 +0000 | [diff] [blame] | 1242 | return converterr("bytearray", arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1243 | break; |
| 1244 | } |
| 1245 | |
| 1246 | case 'U': { /* PyUnicode object */ |
| 1247 | PyObject **p = va_arg(*p_va, PyObject **); |
Victor Stinner | a1b0c9f | 2012-05-29 12:30:29 +0200 | [diff] [blame] | 1248 | if (PyUnicode_Check(arg)) { |
| 1249 | if (PyUnicode_READY(arg) == -1) |
| 1250 | RETURN_ERR_OCCURRED; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1251 | *p = arg; |
Victor Stinner | a1b0c9f | 2012-05-29 12:30:29 +0200 | [diff] [blame] | 1252 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1253 | else |
| 1254 | return converterr("str", arg, msgbuf, bufsize); |
| 1255 | break; |
| 1256 | } |
| 1257 | |
| 1258 | case 'O': { /* object */ |
| 1259 | PyTypeObject *type; |
| 1260 | PyObject **p; |
| 1261 | if (*format == '!') { |
| 1262 | type = va_arg(*p_va, PyTypeObject*); |
| 1263 | p = va_arg(*p_va, PyObject **); |
| 1264 | format++; |
Victor Stinner | a102ed7 | 2020-02-07 02:24:48 +0100 | [diff] [blame] | 1265 | if (PyType_IsSubtype(Py_TYPE(arg), type)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1266 | *p = arg; |
| 1267 | else |
| 1268 | return converterr(type->tp_name, arg, msgbuf, bufsize); |
| 1269 | |
| 1270 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1271 | else if (*format == '&') { |
| 1272 | typedef int (*converter)(PyObject *, void *); |
| 1273 | converter convert = va_arg(*p_va, converter); |
| 1274 | void *addr = va_arg(*p_va, void *); |
| 1275 | int res; |
| 1276 | format++; |
| 1277 | if (! (res = (*convert)(arg, addr))) |
| 1278 | return converterr("(unspecified)", |
| 1279 | arg, msgbuf, bufsize); |
| 1280 | if (res == Py_CLEANUP_SUPPORTED && |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1281 | addcleanup(addr, freelist, convert) == -1) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1282 | return converterr("(cleanup problem)", |
| 1283 | arg, msgbuf, bufsize); |
| 1284 | } |
| 1285 | else { |
| 1286 | p = va_arg(*p_va, PyObject **); |
| 1287 | *p = arg; |
| 1288 | } |
| 1289 | break; |
| 1290 | } |
| 1291 | |
| 1292 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1293 | case 'w': { /* "w*": memory buffer, read-write access */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1294 | void **p = va_arg(*p_va, void **); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1295 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1296 | if (*format != '*') |
| 1297 | return converterr( |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 1298 | "(invalid use of 'w' format character)", |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1299 | arg, msgbuf, bufsize); |
| 1300 | format++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1301 | |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1302 | /* Caller is interested in Py_buffer, and the object |
| 1303 | supports it directly. */ |
| 1304 | if (PyObject_GetBuffer(arg, (Py_buffer*)p, PyBUF_WRITABLE) < 0) { |
| 1305 | PyErr_Clear(); |
R David Murray | 861470c | 2014-10-05 11:47:01 -0400 | [diff] [blame] | 1306 | return converterr("read-write bytes-like object", |
| 1307 | arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1308 | } |
Victor Stinner | 8182b71 | 2010-07-28 00:40:58 +0000 | [diff] [blame] | 1309 | if (!PyBuffer_IsContiguous((Py_buffer*)p, 'C')) { |
| 1310 | PyBuffer_Release((Py_buffer*)p); |
| 1311 | return converterr("contiguous buffer", arg, msgbuf, bufsize); |
| 1312 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1313 | if (addcleanup(p, freelist, cleanup_buffer)) { |
Victor Stinner | 25e8ec4 | 2010-06-25 00:02:38 +0000 | [diff] [blame] | 1314 | return converterr( |
| 1315 | "(cleanup problem)", |
| 1316 | arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1317 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1318 | break; |
| 1319 | } |
| 1320 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1321 | default: |
Serhiy Storchaka | c4b813d | 2016-02-08 01:06:11 +0200 | [diff] [blame] | 1322 | return converterr("(impossible<bad format char>)", arg, msgbuf, bufsize); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1323 | |
| 1324 | } |
| 1325 | |
| 1326 | *p_format = format; |
| 1327 | return NULL; |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 1328 | |
Victor Stinner | 37bb289 | 2020-06-19 11:45:31 +0200 | [diff] [blame] | 1329 | #undef REQUIRE_PY_SSIZE_T_CLEAN |
Victor Stinner | 6ab8e82 | 2011-01-04 11:16:49 +0000 | [diff] [blame] | 1330 | #undef RETURN_ERR_OCCURRED |
Guido van Rossum | fe3f1a2 | 1994-09-29 09:42:55 +0000 | [diff] [blame] | 1331 | } |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1332 | |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1333 | static Py_ssize_t |
Serhiy Storchaka | 85b0f5b | 2016-11-20 10:16:47 +0200 | [diff] [blame] | 1334 | convertbuffer(PyObject *arg, const void **p, const char **errmsg) |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 1335 | { |
Victor Stinner | 5cb6239 | 2010-06-06 20:27:51 +0000 | [diff] [blame] | 1336 | PyBufferProcs *pb = Py_TYPE(arg)->tp_as_buffer; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1337 | Py_ssize_t count; |
| 1338 | Py_buffer view; |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 1339 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1340 | *errmsg = NULL; |
| 1341 | *p = NULL; |
Victor Stinner | 8182b71 | 2010-07-28 00:40:58 +0000 | [diff] [blame] | 1342 | if (pb != NULL && pb->bf_releasebuffer != NULL) { |
R David Murray | 861470c | 2014-10-05 11:47:01 -0400 | [diff] [blame] | 1343 | *errmsg = "read-only bytes-like object"; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1344 | return -1; |
| 1345 | } |
Travis E. Oliphant | b99f762 | 2007-08-18 11:21:56 +0000 | [diff] [blame] | 1346 | |
Victor Stinner | 8182b71 | 2010-07-28 00:40:58 +0000 | [diff] [blame] | 1347 | if (getbuffer(arg, &view, errmsg) < 0) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1348 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1349 | count = view.len; |
| 1350 | *p = view.buf; |
| 1351 | PyBuffer_Release(&view); |
| 1352 | return count; |
Jeremy Hylton | 1cb7aa3 | 2001-05-29 17:37:05 +0000 | [diff] [blame] | 1353 | } |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1354 | |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 1355 | static int |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 1356 | getbuffer(PyObject *arg, Py_buffer *view, const char **errmsg) |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 1357 | { |
Victor Stinner | 8182b71 | 2010-07-28 00:40:58 +0000 | [diff] [blame] | 1358 | if (PyObject_GetBuffer(arg, view, PyBUF_SIMPLE) != 0) { |
R David Murray | 861470c | 2014-10-05 11:47:01 -0400 | [diff] [blame] | 1359 | *errmsg = "bytes-like object"; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1360 | return -1; |
| 1361 | } |
Victor Stinner | 5cb6239 | 2010-06-06 20:27:51 +0000 | [diff] [blame] | 1362 | if (!PyBuffer_IsContiguous(view, 'C')) { |
Victor Stinner | 21e0948 | 2010-06-24 22:57:10 +0000 | [diff] [blame] | 1363 | PyBuffer_Release(view); |
Victor Stinner | 5cb6239 | 2010-06-06 20:27:51 +0000 | [diff] [blame] | 1364 | *errmsg = "contiguous buffer"; |
| 1365 | return -1; |
| 1366 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1367 | return 0; |
Martin v. Löwis | 423be95 | 2008-08-13 15:53:07 +0000 | [diff] [blame] | 1368 | } |
| 1369 | |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1370 | /* Support for keyword arguments donated by |
| 1371 | Geoff Philbrick <philbric@delphi.hks.com> */ |
| 1372 | |
Tim Peters | f8cd3e8 | 2001-10-27 04:26:57 +0000 | [diff] [blame] | 1373 | /* Return false (0) for error, else true. */ |
Fred Drake | 563dfc2 | 2001-10-23 14:41:08 +0000 | [diff] [blame] | 1374 | int |
| 1375 | PyArg_ParseTupleAndKeywords(PyObject *args, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1376 | PyObject *keywords, |
| 1377 | const char *format, |
| 1378 | char **kwlist, ...) |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1379 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1380 | int retval; |
| 1381 | va_list va; |
Tim Peters | 45772cd | 2001-10-27 03:58:40 +0000 | [diff] [blame] | 1382 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1383 | if ((args == NULL || !PyTuple_Check(args)) || |
| 1384 | (keywords != NULL && !PyDict_Check(keywords)) || |
| 1385 | format == NULL || |
| 1386 | kwlist == NULL) |
| 1387 | { |
| 1388 | PyErr_BadInternalCall(); |
| 1389 | return 0; |
| 1390 | } |
Tim Peters | 45772cd | 2001-10-27 03:58:40 +0000 | [diff] [blame] | 1391 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1392 | va_start(va, kwlist); |
| 1393 | retval = vgetargskeywords(args, keywords, format, kwlist, &va, 0); |
| 1394 | va_end(va); |
| 1395 | return retval; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1396 | } |
| 1397 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1398 | PyAPI_FUNC(int) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1399 | _PyArg_ParseTupleAndKeywords_SizeT(PyObject *args, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1400 | PyObject *keywords, |
| 1401 | const char *format, |
| 1402 | char **kwlist, ...) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1403 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1404 | int retval; |
| 1405 | va_list va; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1406 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1407 | if ((args == NULL || !PyTuple_Check(args)) || |
| 1408 | (keywords != NULL && !PyDict_Check(keywords)) || |
| 1409 | format == NULL || |
| 1410 | kwlist == NULL) |
| 1411 | { |
| 1412 | PyErr_BadInternalCall(); |
| 1413 | return 0; |
| 1414 | } |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1415 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1416 | va_start(va, kwlist); |
| 1417 | retval = vgetargskeywords(args, keywords, format, |
| 1418 | kwlist, &va, FLAG_SIZE_T); |
| 1419 | va_end(va); |
| 1420 | return retval; |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1421 | } |
| 1422 | |
| 1423 | |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1424 | int |
| 1425 | PyArg_VaParseTupleAndKeywords(PyObject *args, |
Jeremy Hylton | af68c87 | 2005-12-10 18:50:16 +0000 | [diff] [blame] | 1426 | PyObject *keywords, |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 1427 | const char *format, |
Martin v. Löwis | 15e6274 | 2006-02-27 16:46:16 +0000 | [diff] [blame] | 1428 | char **kwlist, va_list va) |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1429 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1430 | int retval; |
| 1431 | va_list lva; |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1432 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1433 | if ((args == NULL || !PyTuple_Check(args)) || |
| 1434 | (keywords != NULL && !PyDict_Check(keywords)) || |
| 1435 | format == NULL || |
| 1436 | kwlist == NULL) |
| 1437 | { |
| 1438 | PyErr_BadInternalCall(); |
| 1439 | return 0; |
| 1440 | } |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1441 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 1442 | va_copy(lva, va); |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1443 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1444 | retval = vgetargskeywords(args, keywords, format, kwlist, &lva, 0); |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 1445 | va_end(lva); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1446 | return retval; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1447 | } |
| 1448 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1449 | PyAPI_FUNC(int) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1450 | _PyArg_VaParseTupleAndKeywords_SizeT(PyObject *args, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1451 | PyObject *keywords, |
| 1452 | const char *format, |
| 1453 | char **kwlist, va_list va) |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1454 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1455 | int retval; |
| 1456 | va_list lva; |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1457 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1458 | if ((args == NULL || !PyTuple_Check(args)) || |
| 1459 | (keywords != NULL && !PyDict_Check(keywords)) || |
| 1460 | format == NULL || |
| 1461 | kwlist == NULL) |
| 1462 | { |
| 1463 | PyErr_BadInternalCall(); |
| 1464 | return 0; |
| 1465 | } |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1466 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 1467 | va_copy(lva, va); |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 1468 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1469 | retval = vgetargskeywords(args, keywords, format, |
| 1470 | kwlist, &lva, FLAG_SIZE_T); |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 1471 | va_end(lva); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1472 | return retval; |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1473 | } |
| 1474 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1475 | PyAPI_FUNC(int) |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1476 | _PyArg_ParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords, |
| 1477 | struct _PyArg_Parser *parser, ...) |
| 1478 | { |
| 1479 | int retval; |
| 1480 | va_list va; |
| 1481 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1482 | va_start(va, parser); |
| 1483 | retval = vgetargskeywordsfast(args, keywords, parser, &va, 0); |
| 1484 | va_end(va); |
| 1485 | return retval; |
| 1486 | } |
| 1487 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1488 | PyAPI_FUNC(int) |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1489 | _PyArg_ParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords, |
| 1490 | struct _PyArg_Parser *parser, ...) |
| 1491 | { |
| 1492 | int retval; |
| 1493 | va_list va; |
| 1494 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1495 | va_start(va, parser); |
| 1496 | retval = vgetargskeywordsfast(args, keywords, parser, &va, FLAG_SIZE_T); |
| 1497 | va_end(va); |
| 1498 | return retval; |
| 1499 | } |
| 1500 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1501 | PyAPI_FUNC(int) |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 1502 | _PyArg_ParseStackAndKeywords(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames, |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1503 | struct _PyArg_Parser *parser, ...) |
| 1504 | { |
| 1505 | int retval; |
| 1506 | va_list va; |
| 1507 | |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1508 | va_start(va, parser); |
| 1509 | retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, 0); |
| 1510 | va_end(va); |
| 1511 | return retval; |
| 1512 | } |
| 1513 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1514 | PyAPI_FUNC(int) |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 1515 | _PyArg_ParseStackAndKeywords_SizeT(PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames, |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1516 | struct _PyArg_Parser *parser, ...) |
| 1517 | { |
| 1518 | int retval; |
| 1519 | va_list va; |
| 1520 | |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1521 | va_start(va, parser); |
| 1522 | retval = vgetargskeywordsfast_impl(args, nargs, NULL, kwnames, parser, &va, FLAG_SIZE_T); |
| 1523 | va_end(va); |
| 1524 | return retval; |
| 1525 | } |
| 1526 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1527 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1528 | PyAPI_FUNC(int) |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1529 | _PyArg_VaParseTupleAndKeywordsFast(PyObject *args, PyObject *keywords, |
| 1530 | struct _PyArg_Parser *parser, va_list va) |
| 1531 | { |
| 1532 | int retval; |
| 1533 | va_list lva; |
| 1534 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 1535 | va_copy(lva, va); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1536 | |
| 1537 | retval = vgetargskeywordsfast(args, keywords, parser, &lva, 0); |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 1538 | va_end(lva); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1539 | return retval; |
| 1540 | } |
| 1541 | |
Vinay Sajip | 0b60f64 | 2019-10-15 08:26:12 +0100 | [diff] [blame] | 1542 | PyAPI_FUNC(int) |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1543 | _PyArg_VaParseTupleAndKeywordsFast_SizeT(PyObject *args, PyObject *keywords, |
| 1544 | struct _PyArg_Parser *parser, va_list va) |
| 1545 | { |
| 1546 | int retval; |
| 1547 | va_list lva; |
| 1548 | |
Benjamin Peterson | 0c21214 | 2016-09-20 20:39:33 -0700 | [diff] [blame] | 1549 | va_copy(lva, va); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1550 | |
| 1551 | retval = vgetargskeywordsfast(args, keywords, parser, &lva, FLAG_SIZE_T); |
Christian Heimes | 2f2fee1 | 2016-09-21 11:37:27 +0200 | [diff] [blame] | 1552 | va_end(lva); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1553 | return retval; |
| 1554 | } |
| 1555 | |
| 1556 | int |
Benjamin Peterson | fb88636 | 2010-04-24 18:21:17 +0000 | [diff] [blame] | 1557 | PyArg_ValidateKeywordArguments(PyObject *kwargs) |
| 1558 | { |
Benjamin Peterson | f609654 | 2010-11-17 22:33:12 +0000 | [diff] [blame] | 1559 | if (!PyDict_Check(kwargs)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1560 | PyErr_BadInternalCall(); |
| 1561 | return 0; |
| 1562 | } |
| 1563 | if (!_PyDict_HasOnlyStringKeys(kwargs)) { |
| 1564 | PyErr_SetString(PyExc_TypeError, |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 1565 | "keywords must be strings"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1566 | return 0; |
| 1567 | } |
| 1568 | return 1; |
Benjamin Peterson | fb88636 | 2010-04-24 18:21:17 +0000 | [diff] [blame] | 1569 | } |
| 1570 | |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 1571 | #define IS_END_OF_FORMAT(c) (c == '\0' || c == ';' || c == ':') |
Brett Cannon | 711e7d9 | 2004-07-10 22:20:32 +0000 | [diff] [blame] | 1572 | |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1573 | static int |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1574 | vgetargskeywords(PyObject *args, PyObject *kwargs, const char *format, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1575 | char **kwlist, va_list *p_va, int flags) |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1576 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1577 | char msgbuf[512]; |
| 1578 | int levels[32]; |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1579 | const char *fname, *msg, *custom_msg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1580 | int min = INT_MAX; |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1581 | int max = INT_MAX; |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1582 | int i, pos, len; |
| 1583 | int skip = 0; |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1584 | Py_ssize_t nargs, nkwargs; |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1585 | PyObject *current_arg; |
Antoine Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 1586 | freelistentry_t static_entries[STATIC_FREELIST_ENTRIES]; |
Benjamin Peterson | 40be9e5 | 2014-02-11 10:09:27 -0500 | [diff] [blame] | 1587 | freelist_t freelist; |
| 1588 | |
| 1589 | freelist.entries = static_entries; |
| 1590 | freelist.first_available = 0; |
| 1591 | freelist.entries_malloced = 0; |
Tim Peters | f4331c1 | 2001-10-27 00:17:34 +0000 | [diff] [blame] | 1592 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1593 | assert(args != NULL && PyTuple_Check(args)); |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1594 | assert(kwargs == NULL || PyDict_Check(kwargs)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1595 | assert(format != NULL); |
| 1596 | assert(kwlist != NULL); |
| 1597 | assert(p_va != NULL); |
Tim Peters | 45772cd | 2001-10-27 03:58:40 +0000 | [diff] [blame] | 1598 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1599 | /* grab the function name or custom error msg first (mutually exclusive) */ |
| 1600 | fname = strchr(format, ':'); |
| 1601 | if (fname) { |
| 1602 | fname++; |
| 1603 | custom_msg = NULL; |
| 1604 | } |
| 1605 | else { |
| 1606 | custom_msg = strchr(format,';'); |
| 1607 | if (custom_msg) |
| 1608 | custom_msg++; |
| 1609 | } |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 1610 | |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1611 | /* scan kwlist and count the number of positional-only parameters */ |
| 1612 | for (pos = 0; kwlist[pos] && !*kwlist[pos]; pos++) { |
| 1613 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1614 | /* scan kwlist and get greatest possible nbr of args */ |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1615 | for (len = pos; kwlist[len]; len++) { |
| 1616 | if (!*kwlist[len]) { |
| 1617 | PyErr_SetString(PyExc_SystemError, |
| 1618 | "Empty keyword parameter name"); |
| 1619 | return cleanreturn(0, &freelist); |
| 1620 | } |
| 1621 | } |
Tim Peters | f8cd3e8 | 2001-10-27 04:26:57 +0000 | [diff] [blame] | 1622 | |
Antoine Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 1623 | if (len > STATIC_FREELIST_ENTRIES) { |
| 1624 | freelist.entries = PyMem_NEW(freelistentry_t, len); |
| 1625 | if (freelist.entries == NULL) { |
| 1626 | PyErr_NoMemory(); |
| 1627 | return 0; |
| 1628 | } |
| 1629 | freelist.entries_malloced = 1; |
Benjamin Peterson | 7ed6727 | 2012-03-16 12:21:02 -0500 | [diff] [blame] | 1630 | } |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1631 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1632 | nargs = PyTuple_GET_SIZE(args); |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1633 | nkwargs = (kwargs == NULL) ? 0 : PyDict_GET_SIZE(kwargs); |
| 1634 | if (nargs + nkwargs > len) { |
Oren Milman | bf9075a | 2017-08-23 21:16:48 +0300 | [diff] [blame] | 1635 | /* Adding "keyword" (when nargs == 0) prevents producing wrong error |
| 1636 | messages in some special cases (see bpo-31229). */ |
Victor Stinner | 6ced7c4 | 2011-03-21 18:15:42 +0100 | [diff] [blame] | 1637 | PyErr_Format(PyExc_TypeError, |
Oren Milman | bf9075a | 2017-08-23 21:16:48 +0300 | [diff] [blame] | 1638 | "%.200s%s takes at most %d %sargument%s (%zd given)", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1639 | (fname == NULL) ? "function" : fname, |
| 1640 | (fname == NULL) ? "" : "()", |
| 1641 | len, |
Oren Milman | bf9075a | 2017-08-23 21:16:48 +0300 | [diff] [blame] | 1642 | (nargs == 0) ? "keyword " : "", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1643 | (len == 1) ? "" : "s", |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1644 | nargs + nkwargs); |
Benjamin Peterson | 01feaec | 2012-03-16 13:25:58 -0500 | [diff] [blame] | 1645 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1646 | } |
Tim Peters | c2f0112 | 2001-10-27 07:25:06 +0000 | [diff] [blame] | 1647 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1648 | /* convert tuple args and keyword args in same loop, using kwlist to drive process */ |
| 1649 | for (i = 0; i < len; i++) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1650 | if (*format == '|') { |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1651 | if (min != INT_MAX) { |
Serhiy Storchaka | a9725f8 | 2016-02-11 12:41:40 +0200 | [diff] [blame] | 1652 | PyErr_SetString(PyExc_SystemError, |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1653 | "Invalid format string (| specified twice)"); |
| 1654 | return cleanreturn(0, &freelist); |
| 1655 | } |
| 1656 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1657 | min = i; |
| 1658 | format++; |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1659 | |
| 1660 | if (max != INT_MAX) { |
Serhiy Storchaka | a9725f8 | 2016-02-11 12:41:40 +0200 | [diff] [blame] | 1661 | PyErr_SetString(PyExc_SystemError, |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1662 | "Invalid format string ($ before |)"); |
| 1663 | return cleanreturn(0, &freelist); |
| 1664 | } |
| 1665 | } |
| 1666 | if (*format == '$') { |
| 1667 | if (max != INT_MAX) { |
Serhiy Storchaka | a9725f8 | 2016-02-11 12:41:40 +0200 | [diff] [blame] | 1668 | PyErr_SetString(PyExc_SystemError, |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1669 | "Invalid format string ($ specified twice)"); |
| 1670 | return cleanreturn(0, &freelist); |
| 1671 | } |
| 1672 | |
| 1673 | max = i; |
| 1674 | format++; |
| 1675 | |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1676 | if (max < pos) { |
| 1677 | PyErr_SetString(PyExc_SystemError, |
| 1678 | "Empty parameter name after $"); |
| 1679 | return cleanreturn(0, &freelist); |
| 1680 | } |
| 1681 | if (skip) { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1682 | /* Now we know the minimal and the maximal numbers of |
| 1683 | * positional arguments and can raise an exception with |
| 1684 | * informative message (see below). */ |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1685 | break; |
| 1686 | } |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1687 | if (max < nargs) { |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 1688 | if (max == 0) { |
| 1689 | PyErr_Format(PyExc_TypeError, |
| 1690 | "%.200s%s takes no positional arguments", |
| 1691 | (fname == NULL) ? "function" : fname, |
| 1692 | (fname == NULL) ? "" : "()"); |
| 1693 | } |
| 1694 | else { |
| 1695 | PyErr_Format(PyExc_TypeError, |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 1696 | "%.200s%s takes %s %d positional argument%s" |
Serhiy Storchaka | d53fe5f | 2019-03-13 22:59:55 +0200 | [diff] [blame] | 1697 | " (%zd given)", |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 1698 | (fname == NULL) ? "function" : fname, |
| 1699 | (fname == NULL) ? "" : "()", |
| 1700 | (min != INT_MAX) ? "at most" : "exactly", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 1701 | max, |
| 1702 | max == 1 ? "" : "s", |
| 1703 | nargs); |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 1704 | } |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1705 | return cleanreturn(0, &freelist); |
| 1706 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1707 | } |
| 1708 | if (IS_END_OF_FORMAT(*format)) { |
Serhiy Storchaka | a9725f8 | 2016-02-11 12:41:40 +0200 | [diff] [blame] | 1709 | PyErr_Format(PyExc_SystemError, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1710 | "More keyword list entries (%d) than " |
| 1711 | "format specifiers (%d)", len, i); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1712 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1713 | } |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1714 | if (!skip) { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1715 | if (i < nargs) { |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1716 | current_arg = PyTuple_GET_ITEM(args, i); |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1717 | } |
| 1718 | else if (nkwargs && i >= pos) { |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 1719 | current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]); |
| 1720 | if (current_arg) { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1721 | --nkwargs; |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 1722 | } |
| 1723 | else if (PyErr_Occurred()) { |
| 1724 | return cleanreturn(0, &freelist); |
| 1725 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1726 | } |
| 1727 | else { |
| 1728 | current_arg = NULL; |
| 1729 | } |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1730 | |
| 1731 | if (current_arg) { |
| 1732 | msg = convertitem(current_arg, &format, p_va, flags, |
| 1733 | levels, msgbuf, sizeof(msgbuf), &freelist); |
| 1734 | if (msg) { |
| 1735 | seterror(i+1, msg, levels, fname, custom_msg); |
| 1736 | return cleanreturn(0, &freelist); |
| 1737 | } |
| 1738 | continue; |
| 1739 | } |
| 1740 | |
| 1741 | if (i < min) { |
| 1742 | if (i < pos) { |
| 1743 | assert (min == INT_MAX); |
| 1744 | assert (max == INT_MAX); |
| 1745 | skip = 1; |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1746 | /* At that moment we still don't know the minimal and |
| 1747 | * the maximal numbers of positional arguments. Raising |
| 1748 | * an exception is deferred until we encounter | and $ |
| 1749 | * or the end of the format. */ |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1750 | } |
| 1751 | else { |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 1752 | PyErr_Format(PyExc_TypeError, "%.200s%s missing required " |
| 1753 | "argument '%s' (pos %d)", |
| 1754 | (fname == NULL) ? "function" : fname, |
| 1755 | (fname == NULL) ? "" : "()", |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1756 | kwlist[i], i+1); |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1757 | return cleanreturn(0, &freelist); |
| 1758 | } |
| 1759 | } |
| 1760 | /* current code reports success when all required args |
| 1761 | * fulfilled and no keyword args left, with no further |
| 1762 | * validation. XXX Maybe skip this in debug build ? |
| 1763 | */ |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1764 | if (!nkwargs && !skip) { |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1765 | return cleanreturn(1, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1766 | } |
| 1767 | } |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1768 | |
Leo Arias | c3d9508 | 2018-02-03 18:36:10 -0600 | [diff] [blame] | 1769 | /* We are into optional args, skip through to any remaining |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1770 | * keyword args */ |
| 1771 | msg = skipitem(&format, p_va, flags); |
| 1772 | if (msg) { |
Serhiy Storchaka | a9725f8 | 2016-02-11 12:41:40 +0200 | [diff] [blame] | 1773 | PyErr_Format(PyExc_SystemError, "%s: '%s'", msg, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1774 | format); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1775 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1776 | } |
| 1777 | } |
Tim Peters | b054be4 | 2001-10-27 05:07:41 +0000 | [diff] [blame] | 1778 | |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1779 | if (skip) { |
| 1780 | PyErr_Format(PyExc_TypeError, |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 1781 | "%.200s%s takes %s %d positional argument%s" |
Serhiy Storchaka | d53fe5f | 2019-03-13 22:59:55 +0200 | [diff] [blame] | 1782 | " (%zd given)", |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 1783 | (fname == NULL) ? "function" : fname, |
| 1784 | (fname == NULL) ? "" : "()", |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1785 | (Py_MIN(pos, min) < i) ? "at least" : "exactly", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 1786 | Py_MIN(pos, min), |
| 1787 | Py_MIN(pos, min) == 1 ? "" : "s", |
| 1788 | nargs); |
Serhiy Storchaka | f41b82f | 2016-06-09 16:30:29 +0300 | [diff] [blame] | 1789 | return cleanreturn(0, &freelist); |
| 1790 | } |
| 1791 | |
Larry Hastings | 83a9f48 | 2012-03-20 20:06:16 +0000 | [diff] [blame] | 1792 | if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) { |
Serhiy Storchaka | a9725f8 | 2016-02-11 12:41:40 +0200 | [diff] [blame] | 1793 | PyErr_Format(PyExc_SystemError, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1794 | "more argument specifiers than keyword list entries " |
| 1795 | "(remaining format:'%s')", format); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1796 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1797 | } |
Tim Peters | c2f0112 | 2001-10-27 07:25:06 +0000 | [diff] [blame] | 1798 | |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 1799 | if (nkwargs > 0) { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1800 | PyObject *key; |
| 1801 | Py_ssize_t j; |
| 1802 | /* make sure there are no arguments given by name and position */ |
| 1803 | for (i = pos; i < nargs; i++) { |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 1804 | current_arg = _PyDict_GetItemStringWithError(kwargs, kwlist[i]); |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1805 | if (current_arg) { |
| 1806 | /* arg present in tuple and in dict */ |
| 1807 | PyErr_Format(PyExc_TypeError, |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 1808 | "argument for %.200s%s given by name ('%s') " |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1809 | "and position (%d)", |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 1810 | (fname == NULL) ? "function" : fname, |
| 1811 | (fname == NULL) ? "" : "()", |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1812 | kwlist[i], i+1); |
| 1813 | return cleanreturn(0, &freelist); |
| 1814 | } |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 1815 | else if (PyErr_Occurred()) { |
| 1816 | return cleanreturn(0, &freelist); |
| 1817 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1818 | } |
| 1819 | /* make sure there are no extraneous keyword arguments */ |
| 1820 | j = 0; |
| 1821 | while (PyDict_Next(kwargs, &j, &key, NULL)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1822 | int match = 0; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1823 | if (!PyUnicode_Check(key)) { |
| 1824 | PyErr_SetString(PyExc_TypeError, |
| 1825 | "keywords must be strings"); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1826 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1827 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 1828 | for (i = pos; i < len; i++) { |
| 1829 | if (_PyUnicode_EqualToASCIIString(key, kwlist[i])) { |
Antoine Pitrou | 7056cb2 | 2013-02-17 01:04:57 +0100 | [diff] [blame] | 1830 | match = 1; |
| 1831 | break; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1832 | } |
| 1833 | } |
| 1834 | if (!match) { |
| 1835 | PyErr_Format(PyExc_TypeError, |
Victor Stinner | 93b5513 | 2010-05-19 00:54:06 +0000 | [diff] [blame] | 1836 | "'%U' is an invalid keyword " |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 1837 | "argument for %.200s%s", |
| 1838 | key, |
| 1839 | (fname == NULL) ? "this function" : fname, |
| 1840 | (fname == NULL) ? "" : "()"); |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1841 | return cleanreturn(0, &freelist); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1842 | } |
| 1843 | } |
| 1844 | } |
| 1845 | |
Jean-Paul Calderone | c961b4a | 2012-03-16 08:51:42 -0400 | [diff] [blame] | 1846 | return cleanreturn(1, &freelist); |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 1847 | } |
| 1848 | |
| 1849 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1850 | /* List of static parsers. */ |
| 1851 | static struct _PyArg_Parser *static_arg_parsers = NULL; |
| 1852 | |
| 1853 | static int |
| 1854 | parser_init(struct _PyArg_Parser *parser) |
| 1855 | { |
| 1856 | const char * const *keywords; |
| 1857 | const char *format, *msg; |
| 1858 | int i, len, min, max, nkw; |
| 1859 | PyObject *kwtuple; |
| 1860 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1861 | assert(parser->keywords != NULL); |
| 1862 | if (parser->kwtuple != NULL) { |
| 1863 | return 1; |
| 1864 | } |
| 1865 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1866 | keywords = parser->keywords; |
| 1867 | /* scan keywords and count the number of positional-only parameters */ |
| 1868 | for (i = 0; keywords[i] && !*keywords[i]; i++) { |
| 1869 | } |
| 1870 | parser->pos = i; |
| 1871 | /* scan keywords and get greatest possible nbr of args */ |
| 1872 | for (; keywords[i]; i++) { |
| 1873 | if (!*keywords[i]) { |
| 1874 | PyErr_SetString(PyExc_SystemError, |
| 1875 | "Empty keyword parameter name"); |
| 1876 | return 0; |
| 1877 | } |
| 1878 | } |
| 1879 | len = i; |
| 1880 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1881 | format = parser->format; |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 1882 | if (format) { |
| 1883 | /* grab the function name or custom error msg first (mutually exclusive) */ |
| 1884 | parser->fname = strchr(parser->format, ':'); |
| 1885 | if (parser->fname) { |
| 1886 | parser->fname++; |
| 1887 | parser->custom_msg = NULL; |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1888 | } |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 1889 | else { |
| 1890 | parser->custom_msg = strchr(parser->format,';'); |
| 1891 | if (parser->custom_msg) |
| 1892 | parser->custom_msg++; |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1893 | } |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 1894 | |
| 1895 | min = max = INT_MAX; |
| 1896 | for (i = 0; i < len; i++) { |
| 1897 | if (*format == '|') { |
| 1898 | if (min != INT_MAX) { |
| 1899 | PyErr_SetString(PyExc_SystemError, |
| 1900 | "Invalid format string (| specified twice)"); |
| 1901 | return 0; |
| 1902 | } |
| 1903 | if (max != INT_MAX) { |
| 1904 | PyErr_SetString(PyExc_SystemError, |
| 1905 | "Invalid format string ($ before |)"); |
| 1906 | return 0; |
| 1907 | } |
| 1908 | min = i; |
| 1909 | format++; |
| 1910 | } |
| 1911 | if (*format == '$') { |
| 1912 | if (max != INT_MAX) { |
| 1913 | PyErr_SetString(PyExc_SystemError, |
| 1914 | "Invalid format string ($ specified twice)"); |
| 1915 | return 0; |
| 1916 | } |
| 1917 | if (i < parser->pos) { |
| 1918 | PyErr_SetString(PyExc_SystemError, |
| 1919 | "Empty parameter name after $"); |
| 1920 | return 0; |
| 1921 | } |
| 1922 | max = i; |
| 1923 | format++; |
| 1924 | } |
| 1925 | if (IS_END_OF_FORMAT(*format)) { |
| 1926 | PyErr_Format(PyExc_SystemError, |
| 1927 | "More keyword list entries (%d) than " |
| 1928 | "format specifiers (%d)", len, i); |
| 1929 | return 0; |
| 1930 | } |
| 1931 | |
| 1932 | msg = skipitem(&format, NULL, 0); |
| 1933 | if (msg) { |
| 1934 | PyErr_Format(PyExc_SystemError, "%s: '%s'", msg, |
| 1935 | format); |
| 1936 | return 0; |
| 1937 | } |
| 1938 | } |
| 1939 | parser->min = Py_MIN(min, len); |
| 1940 | parser->max = Py_MIN(max, len); |
| 1941 | |
| 1942 | if (!IS_END_OF_FORMAT(*format) && (*format != '|') && (*format != '$')) { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1943 | PyErr_Format(PyExc_SystemError, |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 1944 | "more argument specifiers than keyword list entries " |
| 1945 | "(remaining format:'%s')", format); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1946 | return 0; |
| 1947 | } |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 1948 | } |
| 1949 | |
| 1950 | nkw = len - parser->pos; |
| 1951 | kwtuple = PyTuple_New(nkw); |
| 1952 | if (kwtuple == NULL) { |
| 1953 | return 0; |
| 1954 | } |
| 1955 | keywords = parser->keywords + parser->pos; |
| 1956 | for (i = 0; i < nkw; i++) { |
| 1957 | PyObject *str = PyUnicode_FromString(keywords[i]); |
| 1958 | if (str == NULL) { |
| 1959 | Py_DECREF(kwtuple); |
| 1960 | return 0; |
| 1961 | } |
| 1962 | PyUnicode_InternInPlace(&str); |
| 1963 | PyTuple_SET_ITEM(kwtuple, i, str); |
| 1964 | } |
| 1965 | parser->kwtuple = kwtuple; |
| 1966 | |
| 1967 | assert(parser->next == NULL); |
| 1968 | parser->next = static_arg_parsers; |
| 1969 | static_arg_parsers = parser; |
| 1970 | return 1; |
| 1971 | } |
| 1972 | |
| 1973 | static void |
| 1974 | parser_clear(struct _PyArg_Parser *parser) |
| 1975 | { |
| 1976 | Py_CLEAR(parser->kwtuple); |
| 1977 | } |
| 1978 | |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1979 | static PyObject* |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 1980 | find_keyword(PyObject *kwnames, PyObject *const *kwstack, PyObject *key) |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1981 | { |
| 1982 | Py_ssize_t i, nkwargs; |
| 1983 | |
| 1984 | nkwargs = PyTuple_GET_SIZE(kwnames); |
Sebastian Berg | 75bb07e | 2019-12-18 00:51:22 -0600 | [diff] [blame] | 1985 | for (i = 0; i < nkwargs; i++) { |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1986 | PyObject *kwname = PyTuple_GET_ITEM(kwnames, i); |
| 1987 | |
Sebastian Berg | 75bb07e | 2019-12-18 00:51:22 -0600 | [diff] [blame] | 1988 | /* kwname == key will normally find a match in since keyword keys |
| 1989 | should be interned strings; if not retry below in a new loop. */ |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1990 | if (kwname == key) { |
| 1991 | return kwstack[i]; |
| 1992 | } |
Sebastian Berg | 75bb07e | 2019-12-18 00:51:22 -0600 | [diff] [blame] | 1993 | } |
| 1994 | |
| 1995 | for (i = 0; i < nkwargs; i++) { |
| 1996 | PyObject *kwname = PyTuple_GET_ITEM(kwnames, i); |
Jeroen Demeyer | 0567786 | 2019-08-16 12:41:27 +0200 | [diff] [blame] | 1997 | assert(PyUnicode_Check(kwname)); |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 1998 | if (_PyUnicode_EQ(kwname, key)) { |
| 1999 | return kwstack[i]; |
| 2000 | } |
| 2001 | } |
| 2002 | return NULL; |
| 2003 | } |
| 2004 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2005 | static int |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 2006 | vgetargskeywordsfast_impl(PyObject *const *args, Py_ssize_t nargs, |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2007 | PyObject *kwargs, PyObject *kwnames, |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2008 | struct _PyArg_Parser *parser, |
| 2009 | va_list *p_va, int flags) |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2010 | { |
| 2011 | PyObject *kwtuple; |
| 2012 | char msgbuf[512]; |
| 2013 | int levels[32]; |
| 2014 | const char *format; |
| 2015 | const char *msg; |
| 2016 | PyObject *keyword; |
| 2017 | int i, pos, len; |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2018 | Py_ssize_t nkwargs; |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2019 | PyObject *current_arg; |
| 2020 | freelistentry_t static_entries[STATIC_FREELIST_ENTRIES]; |
| 2021 | freelist_t freelist; |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 2022 | PyObject *const *kwstack = NULL; |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2023 | |
| 2024 | freelist.entries = static_entries; |
| 2025 | freelist.first_available = 0; |
| 2026 | freelist.entries_malloced = 0; |
| 2027 | |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2028 | assert(kwargs == NULL || PyDict_Check(kwargs)); |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2029 | assert(kwargs == NULL || kwnames == NULL); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2030 | assert(p_va != NULL); |
| 2031 | |
Victor Stinner | 80ab22f | 2017-01-16 23:16:47 +0100 | [diff] [blame] | 2032 | if (parser == NULL) { |
| 2033 | PyErr_BadInternalCall(); |
| 2034 | return 0; |
| 2035 | } |
| 2036 | |
| 2037 | if (kwnames != NULL && !PyTuple_Check(kwnames)) { |
| 2038 | PyErr_BadInternalCall(); |
| 2039 | return 0; |
| 2040 | } |
| 2041 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2042 | if (!parser_init(parser)) { |
| 2043 | return 0; |
| 2044 | } |
| 2045 | |
| 2046 | kwtuple = parser->kwtuple; |
| 2047 | pos = parser->pos; |
Segev Finer | e7bc7aa | 2017-07-26 18:58:25 +0300 | [diff] [blame] | 2048 | len = pos + (int)PyTuple_GET_SIZE(kwtuple); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2049 | |
| 2050 | if (len > STATIC_FREELIST_ENTRIES) { |
| 2051 | freelist.entries = PyMem_NEW(freelistentry_t, len); |
| 2052 | if (freelist.entries == NULL) { |
| 2053 | PyErr_NoMemory(); |
| 2054 | return 0; |
| 2055 | } |
| 2056 | freelist.entries_malloced = 1; |
| 2057 | } |
| 2058 | |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2059 | if (kwargs != NULL) { |
| 2060 | nkwargs = PyDict_GET_SIZE(kwargs); |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2061 | } |
| 2062 | else if (kwnames != NULL) { |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2063 | nkwargs = PyTuple_GET_SIZE(kwnames); |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2064 | kwstack = args + nargs; |
| 2065 | } |
| 2066 | else { |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2067 | nkwargs = 0; |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2068 | } |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2069 | if (nargs + nkwargs > len) { |
Oren Milman | bf9075a | 2017-08-23 21:16:48 +0300 | [diff] [blame] | 2070 | /* Adding "keyword" (when nargs == 0) prevents producing wrong error |
| 2071 | messages in some special cases (see bpo-31229). */ |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2072 | PyErr_Format(PyExc_TypeError, |
Oren Milman | bf9075a | 2017-08-23 21:16:48 +0300 | [diff] [blame] | 2073 | "%.200s%s takes at most %d %sargument%s (%zd given)", |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2074 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2075 | (parser->fname == NULL) ? "" : "()", |
| 2076 | len, |
Oren Milman | bf9075a | 2017-08-23 21:16:48 +0300 | [diff] [blame] | 2077 | (nargs == 0) ? "keyword " : "", |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2078 | (len == 1) ? "" : "s", |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2079 | nargs + nkwargs); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2080 | return cleanreturn(0, &freelist); |
| 2081 | } |
| 2082 | if (parser->max < nargs) { |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 2083 | if (parser->max == 0) { |
| 2084 | PyErr_Format(PyExc_TypeError, |
Serhiy Storchaka | f9f1cca | 2017-06-09 19:27:06 +0300 | [diff] [blame] | 2085 | "%.200s%s takes no positional arguments", |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 2086 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2087 | (parser->fname == NULL) ? "" : "()"); |
| 2088 | } |
| 2089 | else { |
| 2090 | PyErr_Format(PyExc_TypeError, |
Serhiy Storchaka | 2c0d3f4 | 2019-03-14 10:06:05 +0200 | [diff] [blame] | 2091 | "%.200s%s takes %s %d positional argument%s (%zd given)", |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 2092 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2093 | (parser->fname == NULL) ? "" : "()", |
Serhiy Storchaka | f2f55e7 | 2019-03-13 23:03:22 +0200 | [diff] [blame] | 2094 | (parser->min < parser->max) ? "at most" : "exactly", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2095 | parser->max, |
| 2096 | parser->max == 1 ? "" : "s", |
| 2097 | nargs); |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 2098 | } |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2099 | return cleanreturn(0, &freelist); |
| 2100 | } |
| 2101 | |
| 2102 | format = parser->format; |
| 2103 | /* convert tuple args and keyword args in same loop, using kwtuple to drive process */ |
| 2104 | for (i = 0; i < len; i++) { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2105 | if (*format == '|') { |
| 2106 | format++; |
| 2107 | } |
| 2108 | if (*format == '$') { |
| 2109 | format++; |
| 2110 | } |
| 2111 | assert(!IS_END_OF_FORMAT(*format)); |
| 2112 | |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2113 | if (i < nargs) { |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2114 | current_arg = args[i]; |
Victor Stinner | a9efb2f | 2016-09-09 17:40:22 -0700 | [diff] [blame] | 2115 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2116 | else if (nkwargs && i >= pos) { |
| 2117 | keyword = PyTuple_GET_ITEM(kwtuple, i - pos); |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 2118 | if (kwargs != NULL) { |
| 2119 | current_arg = PyDict_GetItemWithError(kwargs, keyword); |
| 2120 | if (!current_arg && PyErr_Occurred()) { |
| 2121 | return cleanreturn(0, &freelist); |
| 2122 | } |
| 2123 | } |
| 2124 | else { |
| 2125 | current_arg = find_keyword(kwnames, kwstack, keyword); |
| 2126 | } |
| 2127 | if (current_arg) { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2128 | --nkwargs; |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 2129 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2130 | } |
| 2131 | else { |
| 2132 | current_arg = NULL; |
| 2133 | } |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2134 | |
| 2135 | if (current_arg) { |
| 2136 | msg = convertitem(current_arg, &format, p_va, flags, |
| 2137 | levels, msgbuf, sizeof(msgbuf), &freelist); |
| 2138 | if (msg) { |
| 2139 | seterror(i+1, msg, levels, parser->fname, parser->custom_msg); |
| 2140 | return cleanreturn(0, &freelist); |
| 2141 | } |
| 2142 | continue; |
| 2143 | } |
| 2144 | |
| 2145 | if (i < parser->min) { |
| 2146 | /* Less arguments than required */ |
| 2147 | if (i < pos) { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2148 | Py_ssize_t min = Py_MIN(pos, parser->min); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2149 | PyErr_Format(PyExc_TypeError, |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2150 | "%.200s%s takes %s %d positional argument%s" |
Serhiy Storchaka | d53fe5f | 2019-03-13 22:59:55 +0200 | [diff] [blame] | 2151 | " (%zd given)", |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 2152 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2153 | (parser->fname == NULL) ? "" : "()", |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2154 | min < parser->max ? "at least" : "exactly", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2155 | min, |
| 2156 | min == 1 ? "" : "s", |
| 2157 | nargs); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2158 | } |
| 2159 | else { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2160 | keyword = PyTuple_GET_ITEM(kwtuple, i - pos); |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 2161 | PyErr_Format(PyExc_TypeError, "%.200s%s missing required " |
| 2162 | "argument '%U' (pos %d)", |
| 2163 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2164 | (parser->fname == NULL) ? "" : "()", |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2165 | keyword, i+1); |
| 2166 | } |
| 2167 | return cleanreturn(0, &freelist); |
| 2168 | } |
| 2169 | /* current code reports success when all required args |
| 2170 | * fulfilled and no keyword args left, with no further |
| 2171 | * validation. XXX Maybe skip this in debug build ? |
| 2172 | */ |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2173 | if (!nkwargs) { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2174 | return cleanreturn(1, &freelist); |
| 2175 | } |
| 2176 | |
Leo Arias | c3d9508 | 2018-02-03 18:36:10 -0600 | [diff] [blame] | 2177 | /* We are into optional args, skip through to any remaining |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2178 | * keyword args */ |
| 2179 | msg = skipitem(&format, p_va, flags); |
| 2180 | assert(msg == NULL); |
| 2181 | } |
| 2182 | |
| 2183 | assert(IS_END_OF_FORMAT(*format) || (*format == '|') || (*format == '$')); |
| 2184 | |
Victor Stinner | c0083fc | 2017-01-17 00:37:42 +0100 | [diff] [blame] | 2185 | if (nkwargs > 0) { |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2186 | Py_ssize_t j; |
| 2187 | /* make sure there are no arguments given by name and position */ |
| 2188 | for (i = pos; i < nargs; i++) { |
| 2189 | keyword = PyTuple_GET_ITEM(kwtuple, i - pos); |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 2190 | if (kwargs != NULL) { |
| 2191 | current_arg = PyDict_GetItemWithError(kwargs, keyword); |
| 2192 | if (!current_arg && PyErr_Occurred()) { |
| 2193 | return cleanreturn(0, &freelist); |
| 2194 | } |
| 2195 | } |
| 2196 | else { |
| 2197 | current_arg = find_keyword(kwnames, kwstack, keyword); |
| 2198 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2199 | if (current_arg) { |
| 2200 | /* arg present in tuple and in dict */ |
| 2201 | PyErr_Format(PyExc_TypeError, |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 2202 | "argument for %.200s%s given by name ('%U') " |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2203 | "and position (%d)", |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 2204 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2205 | (parser->fname == NULL) ? "" : "()", |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2206 | keyword, i+1); |
| 2207 | return cleanreturn(0, &freelist); |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2208 | } |
| 2209 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2210 | /* make sure there are no extraneous keyword arguments */ |
| 2211 | j = 0; |
| 2212 | while (1) { |
| 2213 | int match; |
| 2214 | if (kwargs != NULL) { |
| 2215 | if (!PyDict_Next(kwargs, &j, &keyword, NULL)) |
| 2216 | break; |
| 2217 | } |
| 2218 | else { |
| 2219 | if (j >= PyTuple_GET_SIZE(kwnames)) |
| 2220 | break; |
| 2221 | keyword = PyTuple_GET_ITEM(kwnames, j); |
| 2222 | j++; |
| 2223 | } |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2224 | |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2225 | match = PySequence_Contains(kwtuple, keyword); |
| 2226 | if (match <= 0) { |
| 2227 | if (!match) { |
| 2228 | PyErr_Format(PyExc_TypeError, |
Jeroen Demeyer | 0567786 | 2019-08-16 12:41:27 +0200 | [diff] [blame] | 2229 | "'%S' is an invalid keyword " |
Michael Seifert | 64c8f70 | 2017-04-09 09:47:12 +0200 | [diff] [blame] | 2230 | "argument for %.200s%s", |
| 2231 | keyword, |
| 2232 | (parser->fname == NULL) ? "this function" : parser->fname, |
| 2233 | (parser->fname == NULL) ? "" : "()"); |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2234 | } |
Serhiy Storchaka | 1741441 | 2017-01-17 10:07:25 +0200 | [diff] [blame] | 2235 | return cleanreturn(0, &freelist); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2236 | } |
| 2237 | } |
| 2238 | } |
| 2239 | |
| 2240 | return cleanreturn(1, &freelist); |
| 2241 | } |
| 2242 | |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2243 | static int |
| 2244 | vgetargskeywordsfast(PyObject *args, PyObject *keywords, |
| 2245 | struct _PyArg_Parser *parser, va_list *p_va, int flags) |
| 2246 | { |
| 2247 | PyObject **stack; |
| 2248 | Py_ssize_t nargs; |
| 2249 | |
Victor Stinner | 80ab22f | 2017-01-16 23:16:47 +0100 | [diff] [blame] | 2250 | if (args == NULL |
| 2251 | || !PyTuple_Check(args) |
| 2252 | || (keywords != NULL && !PyDict_Check(keywords))) |
| 2253 | { |
| 2254 | PyErr_BadInternalCall(); |
| 2255 | return 0; |
| 2256 | } |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2257 | |
Victor Stinner | d17a693 | 2018-11-09 16:56:48 +0100 | [diff] [blame] | 2258 | stack = _PyTuple_ITEMS(args); |
Victor Stinner | f0ccbbb | 2016-09-09 17:40:38 -0700 | [diff] [blame] | 2259 | nargs = PyTuple_GET_SIZE(args); |
| 2260 | return vgetargskeywordsfast_impl(stack, nargs, keywords, NULL, |
| 2261 | parser, p_va, flags); |
| 2262 | } |
| 2263 | |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2264 | |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 2265 | #undef _PyArg_UnpackKeywords |
| 2266 | |
| 2267 | PyObject * const * |
| 2268 | _PyArg_UnpackKeywords(PyObject *const *args, Py_ssize_t nargs, |
| 2269 | PyObject *kwargs, PyObject *kwnames, |
| 2270 | struct _PyArg_Parser *parser, |
| 2271 | int minpos, int maxpos, int minkw, |
| 2272 | PyObject **buf) |
| 2273 | { |
| 2274 | PyObject *kwtuple; |
| 2275 | PyObject *keyword; |
| 2276 | int i, posonly, minposonly, maxargs; |
| 2277 | int reqlimit = minkw ? maxpos + minkw : minpos; |
| 2278 | Py_ssize_t nkwargs; |
| 2279 | PyObject *current_arg; |
| 2280 | PyObject * const *kwstack = NULL; |
| 2281 | |
| 2282 | assert(kwargs == NULL || PyDict_Check(kwargs)); |
| 2283 | assert(kwargs == NULL || kwnames == NULL); |
| 2284 | |
| 2285 | if (parser == NULL) { |
| 2286 | PyErr_BadInternalCall(); |
| 2287 | return NULL; |
| 2288 | } |
| 2289 | |
| 2290 | if (kwnames != NULL && !PyTuple_Check(kwnames)) { |
| 2291 | PyErr_BadInternalCall(); |
| 2292 | return NULL; |
| 2293 | } |
| 2294 | |
| 2295 | if (args == NULL && nargs == 0) { |
| 2296 | args = buf; |
| 2297 | } |
| 2298 | |
| 2299 | if (!parser_init(parser)) { |
| 2300 | return NULL; |
| 2301 | } |
| 2302 | |
| 2303 | kwtuple = parser->kwtuple; |
| 2304 | posonly = parser->pos; |
| 2305 | minposonly = Py_MIN(posonly, minpos); |
| 2306 | maxargs = posonly + (int)PyTuple_GET_SIZE(kwtuple); |
| 2307 | |
| 2308 | if (kwargs != NULL) { |
| 2309 | nkwargs = PyDict_GET_SIZE(kwargs); |
| 2310 | } |
| 2311 | else if (kwnames != NULL) { |
| 2312 | nkwargs = PyTuple_GET_SIZE(kwnames); |
| 2313 | kwstack = args + nargs; |
| 2314 | } |
| 2315 | else { |
| 2316 | nkwargs = 0; |
| 2317 | } |
| 2318 | if (nkwargs == 0 && minkw == 0 && minpos <= nargs && nargs <= maxpos) { |
| 2319 | /* Fast path. */ |
| 2320 | return args; |
| 2321 | } |
| 2322 | if (nargs + nkwargs > maxargs) { |
| 2323 | /* Adding "keyword" (when nargs == 0) prevents producing wrong error |
| 2324 | messages in some special cases (see bpo-31229). */ |
| 2325 | PyErr_Format(PyExc_TypeError, |
| 2326 | "%.200s%s takes at most %d %sargument%s (%zd given)", |
| 2327 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2328 | (parser->fname == NULL) ? "" : "()", |
| 2329 | maxargs, |
| 2330 | (nargs == 0) ? "keyword " : "", |
| 2331 | (maxargs == 1) ? "" : "s", |
| 2332 | nargs + nkwargs); |
| 2333 | return NULL; |
| 2334 | } |
| 2335 | if (nargs > maxpos) { |
| 2336 | if (maxpos == 0) { |
| 2337 | PyErr_Format(PyExc_TypeError, |
| 2338 | "%.200s%s takes no positional arguments", |
| 2339 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2340 | (parser->fname == NULL) ? "" : "()"); |
| 2341 | } |
| 2342 | else { |
| 2343 | PyErr_Format(PyExc_TypeError, |
| 2344 | "%.200s%s takes %s %d positional argument%s (%zd given)", |
| 2345 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2346 | (parser->fname == NULL) ? "" : "()", |
| 2347 | (minpos < maxpos) ? "at most" : "exactly", |
| 2348 | maxpos, |
| 2349 | (maxpos == 1) ? "" : "s", |
| 2350 | nargs); |
| 2351 | } |
| 2352 | return NULL; |
| 2353 | } |
| 2354 | if (nargs < minposonly) { |
| 2355 | PyErr_Format(PyExc_TypeError, |
| 2356 | "%.200s%s takes %s %d positional argument%s" |
| 2357 | " (%zd given)", |
| 2358 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2359 | (parser->fname == NULL) ? "" : "()", |
| 2360 | minposonly < maxpos ? "at least" : "exactly", |
| 2361 | minposonly, |
| 2362 | minposonly == 1 ? "" : "s", |
| 2363 | nargs); |
| 2364 | return NULL; |
| 2365 | } |
| 2366 | |
| 2367 | /* copy tuple args */ |
| 2368 | for (i = 0; i < nargs; i++) { |
| 2369 | buf[i] = args[i]; |
| 2370 | } |
| 2371 | |
| 2372 | /* copy keyword args using kwtuple to drive process */ |
Serhiy Storchaka | 1b0393d | 2019-03-16 19:45:00 +0200 | [diff] [blame] | 2373 | for (i = Py_MAX((int)nargs, posonly); i < maxargs; i++) { |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 2374 | if (nkwargs) { |
| 2375 | keyword = PyTuple_GET_ITEM(kwtuple, i - posonly); |
| 2376 | if (kwargs != NULL) { |
| 2377 | current_arg = PyDict_GetItemWithError(kwargs, keyword); |
| 2378 | if (!current_arg && PyErr_Occurred()) { |
| 2379 | return NULL; |
| 2380 | } |
| 2381 | } |
| 2382 | else { |
| 2383 | current_arg = find_keyword(kwnames, kwstack, keyword); |
| 2384 | } |
| 2385 | } |
| 2386 | else if (i >= reqlimit) { |
| 2387 | break; |
| 2388 | } |
| 2389 | else { |
| 2390 | current_arg = NULL; |
| 2391 | } |
| 2392 | |
| 2393 | buf[i] = current_arg; |
| 2394 | |
| 2395 | if (current_arg) { |
| 2396 | --nkwargs; |
| 2397 | } |
| 2398 | else if (i < minpos || (maxpos <= i && i < reqlimit)) { |
| 2399 | /* Less arguments than required */ |
| 2400 | keyword = PyTuple_GET_ITEM(kwtuple, i - posonly); |
| 2401 | PyErr_Format(PyExc_TypeError, "%.200s%s missing required " |
| 2402 | "argument '%U' (pos %d)", |
| 2403 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2404 | (parser->fname == NULL) ? "" : "()", |
| 2405 | keyword, i+1); |
| 2406 | return NULL; |
| 2407 | } |
| 2408 | } |
| 2409 | |
| 2410 | if (nkwargs > 0) { |
| 2411 | Py_ssize_t j; |
| 2412 | /* make sure there are no arguments given by name and position */ |
| 2413 | for (i = posonly; i < nargs; i++) { |
| 2414 | keyword = PyTuple_GET_ITEM(kwtuple, i - posonly); |
| 2415 | if (kwargs != NULL) { |
| 2416 | current_arg = PyDict_GetItemWithError(kwargs, keyword); |
| 2417 | if (!current_arg && PyErr_Occurred()) { |
| 2418 | return NULL; |
| 2419 | } |
| 2420 | } |
| 2421 | else { |
| 2422 | current_arg = find_keyword(kwnames, kwstack, keyword); |
| 2423 | } |
| 2424 | if (current_arg) { |
| 2425 | /* arg present in tuple and in dict */ |
| 2426 | PyErr_Format(PyExc_TypeError, |
| 2427 | "argument for %.200s%s given by name ('%U') " |
| 2428 | "and position (%d)", |
| 2429 | (parser->fname == NULL) ? "function" : parser->fname, |
| 2430 | (parser->fname == NULL) ? "" : "()", |
| 2431 | keyword, i+1); |
| 2432 | return NULL; |
| 2433 | } |
| 2434 | } |
| 2435 | /* make sure there are no extraneous keyword arguments */ |
| 2436 | j = 0; |
| 2437 | while (1) { |
| 2438 | int match; |
| 2439 | if (kwargs != NULL) { |
| 2440 | if (!PyDict_Next(kwargs, &j, &keyword, NULL)) |
| 2441 | break; |
| 2442 | } |
| 2443 | else { |
| 2444 | if (j >= PyTuple_GET_SIZE(kwnames)) |
| 2445 | break; |
| 2446 | keyword = PyTuple_GET_ITEM(kwnames, j); |
| 2447 | j++; |
| 2448 | } |
| 2449 | |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 2450 | match = PySequence_Contains(kwtuple, keyword); |
| 2451 | if (match <= 0) { |
| 2452 | if (!match) { |
| 2453 | PyErr_Format(PyExc_TypeError, |
Jeroen Demeyer | 0567786 | 2019-08-16 12:41:27 +0200 | [diff] [blame] | 2454 | "'%S' is an invalid keyword " |
Serhiy Storchaka | 3191391 | 2019-03-14 10:32:22 +0200 | [diff] [blame] | 2455 | "argument for %.200s%s", |
| 2456 | keyword, |
| 2457 | (parser->fname == NULL) ? "this function" : parser->fname, |
| 2458 | (parser->fname == NULL) ? "" : "()"); |
| 2459 | } |
| 2460 | return NULL; |
| 2461 | } |
| 2462 | } |
| 2463 | } |
| 2464 | |
| 2465 | return buf; |
| 2466 | } |
| 2467 | |
| 2468 | |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 2469 | static const char * |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 2470 | skipitem(const char **p_format, va_list *p_va, int flags) |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 2471 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2472 | const char *format = *p_format; |
| 2473 | char c = *format++; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 2474 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2475 | switch (c) { |
Georg Brandl | 6dd1461 | 2005-09-14 19:29:53 +0000 | [diff] [blame] | 2476 | |
Larry Hastings | a347901 | 2012-05-08 23:52:03 -0700 | [diff] [blame] | 2477 | /* |
| 2478 | * codes that take a single data pointer as an argument |
| 2479 | * (the type of the pointer is irrelevant) |
| 2480 | */ |
Georg Brandl | 6dd1461 | 2005-09-14 19:29:53 +0000 | [diff] [blame] | 2481 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2482 | case 'b': /* byte -- very short int */ |
| 2483 | case 'B': /* byte as bitfield */ |
| 2484 | case 'h': /* short int */ |
| 2485 | case 'H': /* short int as bitfield */ |
| 2486 | case 'i': /* int */ |
| 2487 | case 'I': /* int sized bitfield */ |
| 2488 | case 'l': /* long int */ |
| 2489 | case 'k': /* long int sized bitfield */ |
Benjamin Peterson | af580df | 2016-09-06 10:46:49 -0700 | [diff] [blame] | 2490 | case 'L': /* long long */ |
| 2491 | case 'K': /* long long sized bitfield */ |
Larry Hastings | a347901 | 2012-05-08 23:52:03 -0700 | [diff] [blame] | 2492 | case 'n': /* Py_ssize_t */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2493 | case 'f': /* float */ |
| 2494 | case 'd': /* double */ |
| 2495 | case 'D': /* complex double */ |
| 2496 | case 'c': /* char */ |
| 2497 | case 'C': /* unicode char */ |
Larry Hastings | 10ba07a | 2012-05-07 02:44:50 -0700 | [diff] [blame] | 2498 | case 'p': /* boolean predicate */ |
Larry Hastings | a347901 | 2012-05-08 23:52:03 -0700 | [diff] [blame] | 2499 | case 'S': /* string object */ |
| 2500 | case 'Y': /* string object */ |
| 2501 | case 'U': /* unicode string object */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2502 | { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2503 | if (p_va != NULL) { |
| 2504 | (void) va_arg(*p_va, void *); |
| 2505 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2506 | break; |
| 2507 | } |
Martin v. Löwis | 18e1655 | 2006-02-15 17:27:45 +0000 | [diff] [blame] | 2508 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2509 | /* string codes */ |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 2510 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2511 | case 'e': /* string with encoding */ |
| 2512 | { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2513 | if (p_va != NULL) { |
| 2514 | (void) va_arg(*p_va, const char *); |
| 2515 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2516 | if (!(*format == 's' || *format == 't')) |
| 2517 | /* after 'e', only 's' and 't' is allowed */ |
| 2518 | goto err; |
| 2519 | format++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2520 | } |
Stefan Krah | f432a32 | 2017-08-21 13:09:59 +0200 | [diff] [blame] | 2521 | /* fall through */ |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 2522 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2523 | case 's': /* string */ |
| 2524 | case 'z': /* string or None */ |
| 2525 | case 'y': /* bytes */ |
| 2526 | case 'u': /* unicode string */ |
Larry Hastings | d9e4a41 | 2012-05-08 03:51:18 -0700 | [diff] [blame] | 2527 | case 'Z': /* unicode string or None */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2528 | case 'w': /* buffer, read-write */ |
| 2529 | { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2530 | if (p_va != NULL) { |
| 2531 | (void) va_arg(*p_va, char **); |
| 2532 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2533 | if (*format == '#') { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2534 | if (p_va != NULL) { |
Miss Islington (bot) | 569ca81 | 2021-05-06 20:18:42 -0700 | [diff] [blame] | 2535 | if (!(flags & FLAG_SIZE_T)) { |
| 2536 | PyErr_SetString(PyExc_SystemError, |
| 2537 | "PY_SSIZE_T_CLEAN macro must be defined for '#' formats"); |
| 2538 | return NULL; |
Inada Naoki | d3c72a2 | 2019-03-23 21:04:40 +0900 | [diff] [blame] | 2539 | } |
Miss Islington (bot) | 569ca81 | 2021-05-06 20:18:42 -0700 | [diff] [blame] | 2540 | (void) va_arg(*p_va, Py_ssize_t *); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2541 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2542 | format++; |
Serhiy Storchaka | 504373c | 2018-07-11 17:41:43 +0300 | [diff] [blame] | 2543 | } else if ((c == 's' || c == 'z' || c == 'y' || c == 'w') |
| 2544 | && *format == '*') |
| 2545 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2546 | format++; |
| 2547 | } |
| 2548 | break; |
| 2549 | } |
Georg Brandl | 6dd1461 | 2005-09-14 19:29:53 +0000 | [diff] [blame] | 2550 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2551 | case 'O': /* object */ |
| 2552 | { |
| 2553 | if (*format == '!') { |
| 2554 | format++; |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2555 | if (p_va != NULL) { |
| 2556 | (void) va_arg(*p_va, PyTypeObject*); |
| 2557 | (void) va_arg(*p_va, PyObject **); |
| 2558 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2559 | } |
| 2560 | else if (*format == '&') { |
| 2561 | typedef int (*converter)(PyObject *, void *); |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2562 | if (p_va != NULL) { |
| 2563 | (void) va_arg(*p_va, converter); |
| 2564 | (void) va_arg(*p_va, void *); |
| 2565 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2566 | format++; |
| 2567 | } |
| 2568 | else { |
Serhiy Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2569 | if (p_va != NULL) { |
| 2570 | (void) va_arg(*p_va, PyObject **); |
| 2571 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2572 | } |
| 2573 | break; |
| 2574 | } |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 2575 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2576 | case '(': /* bypass tuple, not handled at all previously */ |
| 2577 | { |
Serhiy Storchaka | ef1585e | 2015-12-25 20:01:53 +0200 | [diff] [blame] | 2578 | const char *msg; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2579 | 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 Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 2592 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2593 | case ')': |
| 2594 | return "Unmatched right paren in format string"; |
Christian Heimes | 380f7f2 | 2008-02-28 11:19:05 +0000 | [diff] [blame] | 2595 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2596 | default: |
Georg Brandl | 6dd1461 | 2005-09-14 19:29:53 +0000 | [diff] [blame] | 2597 | err: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2598 | return "impossible<bad format char>"; |
Guido van Rossum | 98297ee | 2007-11-06 21:34:58 +0000 | [diff] [blame] | 2599 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2600 | } |
Georg Brandl | 6dd1461 | 2005-09-14 19:29:53 +0000 | [diff] [blame] | 2601 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2602 | *p_format = format; |
| 2603 | return NULL; |
Guido van Rossum | aa35465 | 1996-08-19 19:32:04 +0000 | [diff] [blame] | 2604 | } |
Fred Drake | e4616e6 | 2001-10-23 21:09:29 +0000 | [diff] [blame] | 2605 | |
| 2606 | |
Serhiy Storchaka | 4fa9591 | 2019-01-11 16:01:14 +0200 | [diff] [blame] | 2607 | #undef _PyArg_CheckPositional |
Fred Drake | e4616e6 | 2001-10-23 21:09:29 +0000 | [diff] [blame] | 2608 | |
Serhiy Storchaka | 4fa9591 | 2019-01-11 16:01:14 +0200 | [diff] [blame] | 2609 | int |
| 2610 | _PyArg_CheckPositional(const char *name, Py_ssize_t nargs, |
| 2611 | Py_ssize_t min, Py_ssize_t max) |
| 2612 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2613 | assert(min >= 0); |
| 2614 | assert(min <= max); |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2615 | |
Victor Stinner | fdbc397 | 2017-02-01 17:42:18 +0100 | [diff] [blame] | 2616 | if (nargs < min) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2617 | if (name != NULL) |
| 2618 | PyErr_Format( |
| 2619 | PyExc_TypeError, |
Xtreak | 1426daa | 2018-07-23 01:43:26 +0530 | [diff] [blame] | 2620 | "%.200s expected %s%zd argument%s, got %zd", |
| 2621 | name, (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2622 | else |
| 2623 | PyErr_Format( |
| 2624 | PyExc_TypeError, |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2625 | "unpacked tuple should have %s%zd element%s," |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2626 | " but has %zd", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2627 | (min == max ? "" : "at least "), min, min == 1 ? "" : "s", nargs); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2628 | return 0; |
| 2629 | } |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2630 | |
Victor Stinner | fdbc397 | 2017-02-01 17:42:18 +0100 | [diff] [blame] | 2631 | if (nargs == 0) { |
Raymond Hettinger | 9423023 | 2016-03-26 03:02:48 -0700 | [diff] [blame] | 2632 | return 1; |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2633 | } |
| 2634 | |
Victor Stinner | fdbc397 | 2017-02-01 17:42:18 +0100 | [diff] [blame] | 2635 | if (nargs > max) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2636 | if (name != NULL) |
| 2637 | PyErr_Format( |
| 2638 | PyExc_TypeError, |
Xtreak | 1426daa | 2018-07-23 01:43:26 +0530 | [diff] [blame] | 2639 | "%.200s expected %s%zd argument%s, got %zd", |
| 2640 | name, (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2641 | else |
| 2642 | PyErr_Format( |
| 2643 | PyExc_TypeError, |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2644 | "unpacked tuple should have %s%zd element%s," |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2645 | " but has %zd", |
Xtreak | 6326278 | 2018-12-21 20:15:13 +0530 | [diff] [blame] | 2646 | (min == max ? "" : "at most "), max, max == 1 ? "" : "s", nargs); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2647 | return 0; |
| 2648 | } |
Raymond Hettinger | 9423023 | 2016-03-26 03:02:48 -0700 | [diff] [blame] | 2649 | |
Serhiy Storchaka | 4fa9591 | 2019-01-11 16:01:14 +0200 | [diff] [blame] | 2650 | return 1; |
| 2651 | } |
| 2652 | |
| 2653 | static int |
| 2654 | unpack_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 Stinner | fdbc397 | 2017-02-01 17:42:18 +0100 | [diff] [blame] | 2664 | for (i = 0; i < nargs; i++) { |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2665 | o = va_arg(vargs, PyObject **); |
| 2666 | *o = args[i]; |
| 2667 | } |
| 2668 | return 1; |
| 2669 | } |
| 2670 | |
| 2671 | int |
| 2672 | PyArg_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 Stinner | d17a693 | 2018-11-09 16:56:48 +0100 | [diff] [blame] | 2684 | stack = _PyTuple_ITEMS(args); |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2685 | nargs = PyTuple_GET_SIZE(args); |
| 2686 | |
Raymond Hettinger | 9423023 | 2016-03-26 03:02:48 -0700 | [diff] [blame] | 2687 | #ifdef HAVE_STDARG_PROTOTYPES |
| 2688 | va_start(vargs, max); |
| 2689 | #else |
| 2690 | va_start(vargs); |
| 2691 | #endif |
Victor Stinner | fdbc397 | 2017-02-01 17:42:18 +0100 | [diff] [blame] | 2692 | retval = unpack_stack(stack, nargs, name, min, max, vargs); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2693 | va_end(vargs); |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2694 | return retval; |
| 2695 | } |
| 2696 | |
| 2697 | int |
Serhiy Storchaka | a5552f0 | 2017-12-15 13:11:11 +0200 | [diff] [blame] | 2698 | _PyArg_UnpackStack(PyObject *const *args, Py_ssize_t nargs, const char *name, |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2699 | 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 Stinner | fdbc397 | 2017-02-01 17:42:18 +0100 | [diff] [blame] | 2709 | retval = unpack_stack(args, nargs, name, min, max, vargs); |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2710 | va_end(vargs); |
| 2711 | return retval; |
Fred Drake | e4616e6 | 2001-10-23 21:09:29 +0000 | [diff] [blame] | 2712 | } |
Georg Brandl | 02c4287 | 2005-08-26 06:42:30 +0000 | [diff] [blame] | 2713 | |
| 2714 | |
Serhiy Storchaka | 68a001d | 2017-02-06 10:41:46 +0200 | [diff] [blame] | 2715 | #undef _PyArg_NoKeywords |
Dong-hee Na | 87ec86c | 2020-03-16 23:06:20 +0900 | [diff] [blame] | 2716 | #undef _PyArg_NoKwnames |
Serhiy Storchaka | 68a001d | 2017-02-06 10:41:46 +0200 | [diff] [blame] | 2717 | #undef _PyArg_NoPositional |
| 2718 | |
Georg Brandl | 02c4287 | 2005-08-26 06:42:30 +0000 | [diff] [blame] | 2719 | /* For type constructors that don't take keyword args |
| 2720 | * |
Larry Hastings | b7ccb20 | 2014-01-18 23:50:21 -0800 | [diff] [blame] | 2721 | * Sets a TypeError and returns 0 if the args/kwargs is |
Thomas Wouters | 89f507f | 2006-12-13 04:49:30 +0000 | [diff] [blame] | 2722 | * not empty, returns 1 otherwise |
Georg Brandl | 02c4287 | 2005-08-26 06:42:30 +0000 | [diff] [blame] | 2723 | */ |
| 2724 | int |
Victor Stinner | 29d39cc | 2017-01-17 01:40:01 +0100 | [diff] [blame] | 2725 | _PyArg_NoKeywords(const char *funcname, PyObject *kwargs) |
Georg Brandl | 02c4287 | 2005-08-26 06:42:30 +0000 | [diff] [blame] | 2726 | { |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2727 | if (kwargs == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2728 | return 1; |
Victor Stinner | fe54dd8 | 2017-01-17 02:33:55 +0100 | [diff] [blame] | 2729 | } |
Victor Stinner | 29d39cc | 2017-01-17 01:40:01 +0100 | [diff] [blame] | 2730 | if (!PyDict_CheckExact(kwargs)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2731 | PyErr_BadInternalCall(); |
| 2732 | return 0; |
| 2733 | } |
Victor Stinner | 29d39cc | 2017-01-17 01:40:01 +0100 | [diff] [blame] | 2734 | if (PyDict_GET_SIZE(kwargs) == 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 2735 | return 1; |
Victor Stinner | 29d39cc | 2017-01-17 01:40:01 +0100 | [diff] [blame] | 2736 | } |
| 2737 | |
Serhiy Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 2738 | PyErr_Format(PyExc_TypeError, "%.200s() takes no keyword arguments", |
Victor Stinner | 29d39cc | 2017-01-17 01:40:01 +0100 | [diff] [blame] | 2739 | funcname); |
| 2740 | return 0; |
| 2741 | } |
| 2742 | |
Victor Stinner | 29d39cc | 2017-01-17 01:40:01 +0100 | [diff] [blame] | 2743 | int |
Larry Hastings | b7ccb20 | 2014-01-18 23:50:21 -0800 | [diff] [blame] | 2744 | _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 Storchaka | 5eb788b | 2017-06-06 18:45:22 +0300 | [diff] [blame] | 2755 | PyErr_Format(PyExc_TypeError, "%.200s() takes no positional arguments", |
Larry Hastings | b7ccb20 | 2014-01-18 23:50:21 -0800 | [diff] [blame] | 2756 | funcname); |
| 2757 | return 0; |
| 2758 | } |
| 2759 | |
Dong-hee Na | 87ec86c | 2020-03-16 23:06:20 +0900 | [diff] [blame] | 2760 | int |
| 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 Storchaka | 9171a8b | 2016-08-14 10:52:18 +0300 | [diff] [blame] | 2777 | void |
| 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 Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 2790 | #ifdef __cplusplus |
| 2791 | }; |
| 2792 | #endif |