blob: b82945ab1d63f162ac3e0ee93c7637ec84060d26 [file] [log] [blame]
Benjamin Peterson4116f362008-05-27 00:36:20 +00001/* bytes object implementation */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00003#define PY_SSIZE_T_CLEAN
Christian Heimes2c9c7a52008-05-26 13:42:13 +00004
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00005#include "Python.h"
Christian Heimes2c9c7a52008-05-26 13:42:13 +00006
Gregory P. Smith60d241f2007-10-16 06:31:30 +00007#include "bytes_methods.h"
Gregory P. Smith8cb65692015-04-25 23:22:26 +00008#include "pystrhex.h"
Mark Dickinsonfd24b322008-12-06 15:33:31 +00009#include <stddef.h>
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000010
Martin v. Löwis7252a6e2014-07-27 16:25:09 +020011/*[clinic input]
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +030012class bytes "PyBytesObject *" "&PyBytes_Type"
Martin v. Löwis7252a6e2014-07-27 16:25:09 +020013[clinic start generated code]*/
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +030014/*[clinic end generated code: output=da39a3ee5e6b4b0d input=7a238f965d64892b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +020015
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030016#include "clinic/bytesobject.c.h"
17
Christian Heimes2c9c7a52008-05-26 13:42:13 +000018#ifdef COUNT_ALLOCS
Benjamin Petersona4a37fe2009-01-11 17:13:55 +000019Py_ssize_t null_strings, one_strings;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000020#endif
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000021
Christian Heimes2c9c7a52008-05-26 13:42:13 +000022static PyBytesObject *characters[UCHAR_MAX + 1];
23static PyBytesObject *nullstring;
24
Mark Dickinsonfd24b322008-12-06 15:33:31 +000025/* PyBytesObject_SIZE gives the basic size of a string; any memory allocation
26 for a string of length n should request PyBytesObject_SIZE + n bytes.
27
28 Using PyBytesObject_SIZE instead of sizeof(PyBytesObject) saves
29 3 bytes per string allocation on a typical system.
30*/
31#define PyBytesObject_SIZE (offsetof(PyBytesObject, ob_sval) + 1)
32
Victor Stinner2bf89932015-10-14 11:25:33 +020033/* Forward declaration */
34Py_LOCAL_INLINE(Py_ssize_t) _PyBytesWriter_GetSize(_PyBytesWriter *writer,
35 char *str);
36
Christian Heimes2c9c7a52008-05-26 13:42:13 +000037/*
Christian Heimes2c9c7a52008-05-26 13:42:13 +000038 For PyBytes_FromString(), the parameter `str' points to a null-terminated
39 string containing exactly `size' bytes.
40
Martin Pantera90a4a92016-05-30 04:04:50 +000041 For PyBytes_FromStringAndSize(), the parameter `str' is
Christian Heimes2c9c7a52008-05-26 13:42:13 +000042 either NULL or else points to a string containing at least `size' bytes.
43 For PyBytes_FromStringAndSize(), the string in the `str' parameter does
44 not have to be null-terminated. (Therefore it is safe to construct a
45 substring by calling `PyBytes_FromStringAndSize(origstring, substrlen)'.)
46 If `str' is NULL then PyBytes_FromStringAndSize() will allocate `size+1'
47 bytes (setting the last byte to the null terminating character) and you can
48 fill in the data yourself. If `str' is non-NULL then the resulting
Antoine Pitrouf2c54842010-01-13 08:07:53 +000049 PyBytes object must be treated as immutable and you must not fill in nor
Christian Heimes2c9c7a52008-05-26 13:42:13 +000050 alter the data yourself, since the strings may be shared.
51
52 The PyObject member `op->ob_size', which denotes the number of "extra
53 items" in a variable-size object, will contain the number of bytes
Eli Bendersky1aef6b62011-03-24 22:32:56 +020054 allocated for string data, not counting the null terminating character.
55 It is therefore equal to the `size' parameter (for
Christian Heimes2c9c7a52008-05-26 13:42:13 +000056 PyBytes_FromStringAndSize()) or the length of the string in the `str'
57 parameter (for PyBytes_FromString()).
58*/
Victor Stinnerdb067af2014-05-02 22:31:14 +020059static PyObject *
60_PyBytes_FromSize(Py_ssize_t size, int use_calloc)
Guido van Rossumd624f182006-04-24 13:47:05 +000061{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +020062 PyBytesObject *op;
Victor Stinnerdb067af2014-05-02 22:31:14 +020063 assert(size >= 0);
Victor Stinner049e5092014-08-17 22:20:00 +020064
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000065 if (size == 0 && (op = nullstring) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +000066#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000067 null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000068#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000069 Py_INCREF(op);
70 return (PyObject *)op;
71 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +000072
Victor Stinner049e5092014-08-17 22:20:00 +020073 if ((size_t)size > (size_t)PY_SSIZE_T_MAX - PyBytesObject_SIZE) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000074 PyErr_SetString(PyExc_OverflowError,
75 "byte string is too large");
76 return NULL;
77 }
Neal Norwitz3ce5d922008-08-24 07:08:55 +000078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000079 /* Inline PyObject_NewVar */
Victor Stinnerdb067af2014-05-02 22:31:14 +020080 if (use_calloc)
81 op = (PyBytesObject *)PyObject_Calloc(1, PyBytesObject_SIZE + size);
82 else
83 op = (PyBytesObject *)PyObject_Malloc(PyBytesObject_SIZE + size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000084 if (op == NULL)
85 return PyErr_NoMemory();
Christian Heimesd3afe782013-12-04 09:27:47 +010086 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 op->ob_shash = -1;
Victor Stinnerdb067af2014-05-02 22:31:14 +020088 if (!use_calloc)
89 op->ob_sval[size] = '\0';
90 /* empty byte string singleton */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000091 if (size == 0) {
92 nullstring = op;
93 Py_INCREF(op);
Victor Stinnerdb067af2014-05-02 22:31:14 +020094 }
95 return (PyObject *) op;
96}
97
98PyObject *
99PyBytes_FromStringAndSize(const char *str, Py_ssize_t size)
100{
101 PyBytesObject *op;
102 if (size < 0) {
103 PyErr_SetString(PyExc_SystemError,
104 "Negative size passed to PyBytes_FromStringAndSize");
105 return NULL;
106 }
107 if (size == 1 && str != NULL &&
108 (op = characters[*str & UCHAR_MAX]) != NULL)
109 {
110#ifdef COUNT_ALLOCS
111 one_strings++;
112#endif
113 Py_INCREF(op);
114 return (PyObject *)op;
115 }
116
117 op = (PyBytesObject *)_PyBytes_FromSize(size, 0);
118 if (op == NULL)
119 return NULL;
120 if (str == NULL)
121 return (PyObject *) op;
122
Christian Heimesf051e432016-09-13 20:22:02 +0200123 memcpy(op->ob_sval, str, size);
Victor Stinnerdb067af2014-05-02 22:31:14 +0200124 /* share short strings */
125 if (size == 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000126 characters[*str & UCHAR_MAX] = op;
127 Py_INCREF(op);
128 }
129 return (PyObject *) op;
Guido van Rossumd624f182006-04-24 13:47:05 +0000130}
131
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000132PyObject *
133PyBytes_FromString(const char *str)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000134{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200135 size_t size;
136 PyBytesObject *op;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000137
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000138 assert(str != NULL);
139 size = strlen(str);
140 if (size > PY_SSIZE_T_MAX - PyBytesObject_SIZE) {
141 PyErr_SetString(PyExc_OverflowError,
142 "byte string is too long");
143 return NULL;
144 }
145 if (size == 0 && (op = nullstring) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000146#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000147 null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000148#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000149 Py_INCREF(op);
150 return (PyObject *)op;
151 }
152 if (size == 1 && (op = characters[*str & UCHAR_MAX]) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000153#ifdef COUNT_ALLOCS
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000154 one_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000155#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000156 Py_INCREF(op);
157 return (PyObject *)op;
158 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000159
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000160 /* Inline PyObject_NewVar */
161 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + size);
162 if (op == NULL)
163 return PyErr_NoMemory();
Christian Heimesd3afe782013-12-04 09:27:47 +0100164 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000165 op->ob_shash = -1;
Christian Heimesf051e432016-09-13 20:22:02 +0200166 memcpy(op->ob_sval, str, size+1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000167 /* share short strings */
168 if (size == 0) {
169 nullstring = op;
170 Py_INCREF(op);
171 } else if (size == 1) {
172 characters[*str & UCHAR_MAX] = op;
173 Py_INCREF(op);
174 }
175 return (PyObject *) op;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000176}
Guido van Rossumebea9be2007-04-09 00:49:13 +0000177
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000178PyObject *
179PyBytes_FromFormatV(const char *format, va_list vargs)
180{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000181 char *s;
Victor Stinner03dab782015-10-14 00:21:35 +0200182 const char *f;
183 const char *p;
184 Py_ssize_t prec;
185 int longflag;
186 int size_tflag;
187 /* Longest 64-bit formatted numbers:
188 - "18446744073709551615\0" (21 bytes)
189 - "-9223372036854775808\0" (21 bytes)
190 Decimal takes the most space (it isn't enough for octal.)
Guido van Rossum343e97f2007-04-09 00:43:24 +0000191
Victor Stinner03dab782015-10-14 00:21:35 +0200192 Longest 64-bit pointer representation:
193 "0xffffffffffffffff\0" (19 bytes). */
194 char buffer[21];
195 _PyBytesWriter writer;
Guido van Rossum343e97f2007-04-09 00:43:24 +0000196
Victor Stinner03dab782015-10-14 00:21:35 +0200197 _PyBytesWriter_Init(&writer);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000198
Victor Stinner03dab782015-10-14 00:21:35 +0200199 s = _PyBytesWriter_Alloc(&writer, strlen(format));
200 if (s == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000201 return NULL;
Victor Stinner03dab782015-10-14 00:21:35 +0200202 writer.overallocate = 1;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000203
Victor Stinner03dab782015-10-14 00:21:35 +0200204#define WRITE_BYTES(str) \
205 do { \
206 s = _PyBytesWriter_WriteBytes(&writer, s, (str), strlen(str)); \
207 if (s == NULL) \
208 goto error; \
209 } while (0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000211 for (f = format; *f; f++) {
Victor Stinner03dab782015-10-14 00:21:35 +0200212 if (*f != '%') {
213 *s++ = *f;
214 continue;
215 }
216
217 p = f++;
218
219 /* ignore the width (ex: 10 in "%10s") */
220 while (Py_ISDIGIT(*f))
221 f++;
222
223 /* parse the precision (ex: 10 in "%.10s") */
224 prec = 0;
225 if (*f == '.') {
226 f++;
227 for (; Py_ISDIGIT(*f); f++) {
228 prec = (prec * 10) + (*f - '0');
229 }
230 }
231
232 while (*f && *f != '%' && !Py_ISALPHA(*f))
233 f++;
234
235 /* handle the long flag ('l'), but only for %ld and %lu.
236 others can be added when necessary. */
237 longflag = 0;
238 if (*f == 'l' && (f[1] == 'd' || f[1] == 'u')) {
239 longflag = 1;
240 ++f;
241 }
242
243 /* handle the size_t flag ('z'). */
244 size_tflag = 0;
245 if (*f == 'z' && (f[1] == 'd' || f[1] == 'u')) {
246 size_tflag = 1;
247 ++f;
248 }
249
Raymond Hettinger15f44ab2016-08-30 10:47:49 -0700250 /* subtract bytes preallocated for the format string
Victor Stinner03dab782015-10-14 00:21:35 +0200251 (ex: 2 for "%s") */
252 writer.min_size -= (f - p + 1);
253
254 switch (*f) {
255 case 'c':
256 {
257 int c = va_arg(vargs, int);
258 if (c < 0 || c > 255) {
259 PyErr_SetString(PyExc_OverflowError,
260 "PyBytes_FromFormatV(): %c format "
261 "expects an integer in range [0; 255]");
262 goto error;
263 }
264 writer.min_size++;
265 *s++ = (unsigned char)c;
266 break;
267 }
268
269 case 'd':
270 if (longflag)
271 sprintf(buffer, "%ld", va_arg(vargs, long));
272 else if (size_tflag)
273 sprintf(buffer, "%" PY_FORMAT_SIZE_T "d",
274 va_arg(vargs, Py_ssize_t));
275 else
276 sprintf(buffer, "%d", va_arg(vargs, int));
277 assert(strlen(buffer) < sizeof(buffer));
278 WRITE_BYTES(buffer);
279 break;
280
281 case 'u':
282 if (longflag)
283 sprintf(buffer, "%lu",
284 va_arg(vargs, unsigned long));
285 else if (size_tflag)
286 sprintf(buffer, "%" PY_FORMAT_SIZE_T "u",
287 va_arg(vargs, size_t));
288 else
289 sprintf(buffer, "%u",
290 va_arg(vargs, unsigned int));
291 assert(strlen(buffer) < sizeof(buffer));
292 WRITE_BYTES(buffer);
293 break;
294
295 case 'i':
296 sprintf(buffer, "%i", va_arg(vargs, int));
297 assert(strlen(buffer) < sizeof(buffer));
298 WRITE_BYTES(buffer);
299 break;
300
301 case 'x':
302 sprintf(buffer, "%x", va_arg(vargs, int));
303 assert(strlen(buffer) < sizeof(buffer));
304 WRITE_BYTES(buffer);
305 break;
306
307 case 's':
308 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000309 Py_ssize_t i;
Victor Stinner03dab782015-10-14 00:21:35 +0200310
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200311 p = va_arg(vargs, const char*);
Victor Stinner03dab782015-10-14 00:21:35 +0200312 i = strlen(p);
313 if (prec > 0 && i > prec)
314 i = prec;
315 s = _PyBytesWriter_WriteBytes(&writer, s, p, i);
316 if (s == NULL)
317 goto error;
318 break;
319 }
320
321 case 'p':
322 sprintf(buffer, "%p", va_arg(vargs, void*));
323 assert(strlen(buffer) < sizeof(buffer));
324 /* %p is ill-defined: ensure leading 0x. */
325 if (buffer[1] == 'X')
326 buffer[1] = 'x';
327 else if (buffer[1] != 'x') {
328 memmove(buffer+2, buffer, strlen(buffer)+1);
329 buffer[0] = '0';
330 buffer[1] = 'x';
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000331 }
Victor Stinner03dab782015-10-14 00:21:35 +0200332 WRITE_BYTES(buffer);
333 break;
334
335 case '%':
336 writer.min_size++;
337 *s++ = '%';
338 break;
339
340 default:
341 if (*f == 0) {
342 /* fix min_size if we reached the end of the format string */
343 writer.min_size++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000344 }
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000345
Victor Stinner03dab782015-10-14 00:21:35 +0200346 /* invalid format string: copy unformatted string and exit */
347 WRITE_BYTES(p);
348 return _PyBytesWriter_Finish(&writer, s);
349 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000350 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000351
Victor Stinner03dab782015-10-14 00:21:35 +0200352#undef WRITE_BYTES
353
354 return _PyBytesWriter_Finish(&writer, s);
355
356 error:
357 _PyBytesWriter_Dealloc(&writer);
358 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000359}
360
361PyObject *
362PyBytes_FromFormat(const char *format, ...)
363{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000364 PyObject* ret;
365 va_list vargs;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000366
367#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000368 va_start(vargs, format);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000369#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000370 va_start(vargs);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000371#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000372 ret = PyBytes_FromFormatV(format, vargs);
373 va_end(vargs);
374 return ret;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000375}
376
Ethan Furmanb95b5612015-01-23 20:05:18 -0800377/* Helpers for formatstring */
378
379Py_LOCAL_INLINE(PyObject *)
380getnextarg(PyObject *args, Py_ssize_t arglen, Py_ssize_t *p_argidx)
381{
382 Py_ssize_t argidx = *p_argidx;
383 if (argidx < arglen) {
384 (*p_argidx)++;
385 if (arglen < 0)
386 return args;
387 else
388 return PyTuple_GetItem(args, argidx);
389 }
390 PyErr_SetString(PyExc_TypeError,
391 "not enough arguments for format string");
392 return NULL;
393}
394
395/* Format codes
396 * F_LJUST '-'
397 * F_SIGN '+'
398 * F_BLANK ' '
399 * F_ALT '#'
400 * F_ZERO '0'
401 */
402#define F_LJUST (1<<0)
403#define F_SIGN (1<<1)
404#define F_BLANK (1<<2)
405#define F_ALT (1<<3)
406#define F_ZERO (1<<4)
407
408/* Returns a new reference to a PyBytes object, or NULL on failure. */
409
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200410static char*
411formatfloat(PyObject *v, int flags, int prec, int type,
Victor Stinnerad771582015-10-09 12:38:53 +0200412 PyObject **p_result, _PyBytesWriter *writer, char *str)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800413{
414 char *p;
415 PyObject *result;
416 double x;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200417 size_t len;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800418
419 x = PyFloat_AsDouble(v);
420 if (x == -1.0 && PyErr_Occurred()) {
421 PyErr_Format(PyExc_TypeError, "float argument required, "
422 "not %.200s", Py_TYPE(v)->tp_name);
423 return NULL;
424 }
425
426 if (prec < 0)
427 prec = 6;
428
429 p = PyOS_double_to_string(x, type, prec,
430 (flags & F_ALT) ? Py_DTSF_ALT : 0, NULL);
431
432 if (p == NULL)
433 return NULL;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200434
435 len = strlen(p);
436 if (writer != NULL) {
Victor Stinnerad771582015-10-09 12:38:53 +0200437 str = _PyBytesWriter_Prepare(writer, str, len);
438 if (str == NULL)
439 return NULL;
Christian Heimesf051e432016-09-13 20:22:02 +0200440 memcpy(str, p, len);
Victor Stinner71dc3d82016-04-26 12:35:13 +0200441 PyMem_Free(p);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200442 str += len;
443 return str;
444 }
445
446 result = PyBytes_FromStringAndSize(p, len);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800447 PyMem_Free(p);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200448 *p_result = result;
449 return str;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800450}
451
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300452static PyObject *
453formatlong(PyObject *v, int flags, int prec, int type)
454{
455 PyObject *result, *iobj;
456 if (type == 'i')
457 type = 'd';
458 if (PyLong_Check(v))
459 return _PyUnicode_FormatLong(v, flags & F_ALT, prec, type);
460 if (PyNumber_Check(v)) {
461 /* make sure number is a type of integer for o, x, and X */
462 if (type == 'o' || type == 'x' || type == 'X')
463 iobj = PyNumber_Index(v);
464 else
465 iobj = PyNumber_Long(v);
466 if (iobj == NULL) {
467 if (!PyErr_ExceptionMatches(PyExc_TypeError))
468 return NULL;
469 }
470 else if (!PyLong_Check(iobj))
471 Py_CLEAR(iobj);
472 if (iobj != NULL) {
473 result = _PyUnicode_FormatLong(iobj, flags & F_ALT, prec, type);
474 Py_DECREF(iobj);
475 return result;
476 }
477 }
478 PyErr_Format(PyExc_TypeError,
479 "%%%c format: %s is required, not %.200s", type,
480 (type == 'o' || type == 'x' || type == 'X') ? "an integer"
481 : "a number",
482 Py_TYPE(v)->tp_name);
483 return NULL;
484}
485
486static int
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200487byte_converter(PyObject *arg, char *p)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800488{
Serhiy Storchakadd40fc32016-05-04 22:23:26 +0300489 if (PyBytes_Check(arg) && PyBytes_GET_SIZE(arg) == 1) {
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200490 *p = PyBytes_AS_STRING(arg)[0];
491 return 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800492 }
Serhiy Storchakadd40fc32016-05-04 22:23:26 +0300493 else if (PyByteArray_Check(arg) && PyByteArray_GET_SIZE(arg) == 1) {
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200494 *p = PyByteArray_AS_STRING(arg)[0];
495 return 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800496 }
497 else {
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300498 PyObject *iobj;
499 long ival;
500 int overflow;
501 /* make sure number is a type of integer */
502 if (PyLong_Check(arg)) {
503 ival = PyLong_AsLongAndOverflow(arg, &overflow);
504 }
505 else {
506 iobj = PyNumber_Index(arg);
507 if (iobj == NULL) {
508 if (!PyErr_ExceptionMatches(PyExc_TypeError))
509 return 0;
510 goto onError;
511 }
512 ival = PyLong_AsLongAndOverflow(iobj, &overflow);
513 Py_DECREF(iobj);
514 }
Serhiy Storchaka41525e32015-04-03 20:53:46 +0300515 if (!overflow && ival == -1 && PyErr_Occurred())
516 goto onError;
517 if (overflow || !(0 <= ival && ival <= 255)) {
518 PyErr_SetString(PyExc_OverflowError,
519 "%c arg not in range(256)");
520 return 0;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800521 }
Serhiy Storchaka41525e32015-04-03 20:53:46 +0300522 *p = (char)ival;
523 return 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800524 }
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300525 onError:
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200526 PyErr_SetString(PyExc_TypeError,
527 "%c requires an integer in range(256) or a single byte");
528 return 0;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800529}
530
531static PyObject *
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200532format_obj(PyObject *v, const char **pbuf, Py_ssize_t *plen)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800533{
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200534 PyObject *func, *result;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800535 _Py_IDENTIFIER(__bytes__);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800536 /* is it a bytes object? */
537 if (PyBytes_Check(v)) {
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200538 *pbuf = PyBytes_AS_STRING(v);
539 *plen = PyBytes_GET_SIZE(v);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800540 Py_INCREF(v);
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200541 return v;
542 }
543 if (PyByteArray_Check(v)) {
544 *pbuf = PyByteArray_AS_STRING(v);
545 *plen = PyByteArray_GET_SIZE(v);
546 Py_INCREF(v);
547 return v;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800548 }
549 /* does it support __bytes__? */
550 func = _PyObject_LookupSpecial(v, &PyId___bytes__);
551 if (func != NULL) {
Victor Stinner27580c12016-12-01 14:43:22 +0100552 result = _PyObject_CallNoArg(func);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800553 Py_DECREF(func);
554 if (result == NULL)
555 return NULL;
556 if (!PyBytes_Check(result)) {
557 PyErr_Format(PyExc_TypeError,
558 "__bytes__ returned non-bytes (type %.200s)",
559 Py_TYPE(result)->tp_name);
560 Py_DECREF(result);
561 return NULL;
562 }
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200563 *pbuf = PyBytes_AS_STRING(result);
564 *plen = PyBytes_GET_SIZE(result);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800565 return result;
566 }
567 PyErr_Format(PyExc_TypeError,
568 "%%b requires bytes, or an object that implements __bytes__, not '%.100s'",
569 Py_TYPE(v)->tp_name);
570 return NULL;
571}
572
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200573/* fmt%(v1,v2,...) is roughly equivalent to sprintf(fmt, v1, v2, ...) */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800574
575PyObject *
Victor Stinner772b2b02015-10-14 09:56:53 +0200576_PyBytes_FormatEx(const char *format, Py_ssize_t format_len,
577 PyObject *args, int use_bytearray)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800578{
Victor Stinner772b2b02015-10-14 09:56:53 +0200579 const char *fmt;
580 char *res;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800581 Py_ssize_t arglen, argidx;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200582 Py_ssize_t fmtcnt;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800583 int args_owned = 0;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800584 PyObject *dict = NULL;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200585 _PyBytesWriter writer;
586
Victor Stinner772b2b02015-10-14 09:56:53 +0200587 if (args == NULL) {
Ethan Furmanb95b5612015-01-23 20:05:18 -0800588 PyErr_BadInternalCall();
589 return NULL;
590 }
Victor Stinner772b2b02015-10-14 09:56:53 +0200591 fmt = format;
592 fmtcnt = format_len;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200593
594 _PyBytesWriter_Init(&writer);
Victor Stinner772b2b02015-10-14 09:56:53 +0200595 writer.use_bytearray = use_bytearray;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200596
597 res = _PyBytesWriter_Alloc(&writer, fmtcnt);
598 if (res == NULL)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800599 return NULL;
Victor Stinner772b2b02015-10-14 09:56:53 +0200600 if (!use_bytearray)
601 writer.overallocate = 1;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200602
Ethan Furmanb95b5612015-01-23 20:05:18 -0800603 if (PyTuple_Check(args)) {
604 arglen = PyTuple_GET_SIZE(args);
605 argidx = 0;
606 }
607 else {
608 arglen = -1;
609 argidx = -2;
610 }
611 if (Py_TYPE(args)->tp_as_mapping && Py_TYPE(args)->tp_as_mapping->mp_subscript &&
612 !PyTuple_Check(args) && !PyBytes_Check(args) && !PyUnicode_Check(args) &&
613 !PyByteArray_Check(args)) {
614 dict = args;
615 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200616
Ethan Furmanb95b5612015-01-23 20:05:18 -0800617 while (--fmtcnt >= 0) {
618 if (*fmt != '%') {
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200619 Py_ssize_t len;
620 char *pos;
621
622 pos = strchr(fmt + 1, '%');
623 if (pos != NULL)
624 len = pos - fmt;
Victor Stinner772b2b02015-10-14 09:56:53 +0200625 else
626 len = format_len - (fmt - format);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200627 assert(len != 0);
628
Christian Heimesf051e432016-09-13 20:22:02 +0200629 memcpy(res, fmt, len);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200630 res += len;
631 fmt += len;
632 fmtcnt -= (len - 1);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800633 }
634 else {
635 /* Got a format specifier */
636 int flags = 0;
637 Py_ssize_t width = -1;
638 int prec = -1;
639 int c = '\0';
640 int fill;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800641 PyObject *v = NULL;
642 PyObject *temp = NULL;
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200643 const char *pbuf = NULL;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800644 int sign;
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200645 Py_ssize_t len = 0;
646 char onechar; /* For byte_converter() */
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200647 Py_ssize_t alloc;
648#ifdef Py_DEBUG
649 char *before;
650#endif
Ethan Furmanb95b5612015-01-23 20:05:18 -0800651
Ethan Furmanb95b5612015-01-23 20:05:18 -0800652 fmt++;
653 if (*fmt == '(') {
Victor Stinner772b2b02015-10-14 09:56:53 +0200654 const char *keystart;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800655 Py_ssize_t keylen;
656 PyObject *key;
657 int pcount = 1;
658
659 if (dict == NULL) {
660 PyErr_SetString(PyExc_TypeError,
661 "format requires a mapping");
662 goto error;
663 }
664 ++fmt;
665 --fmtcnt;
666 keystart = fmt;
667 /* Skip over balanced parentheses */
668 while (pcount > 0 && --fmtcnt >= 0) {
669 if (*fmt == ')')
670 --pcount;
671 else if (*fmt == '(')
672 ++pcount;
673 fmt++;
674 }
675 keylen = fmt - keystart - 1;
676 if (fmtcnt < 0 || pcount > 0) {
677 PyErr_SetString(PyExc_ValueError,
678 "incomplete format key");
679 goto error;
680 }
681 key = PyBytes_FromStringAndSize(keystart,
682 keylen);
683 if (key == NULL)
684 goto error;
685 if (args_owned) {
686 Py_DECREF(args);
687 args_owned = 0;
688 }
689 args = PyObject_GetItem(dict, key);
690 Py_DECREF(key);
691 if (args == NULL) {
692 goto error;
693 }
694 args_owned = 1;
695 arglen = -1;
696 argidx = -2;
697 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200698
699 /* Parse flags. Example: "%+i" => flags=F_SIGN. */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800700 while (--fmtcnt >= 0) {
701 switch (c = *fmt++) {
702 case '-': flags |= F_LJUST; continue;
703 case '+': flags |= F_SIGN; continue;
704 case ' ': flags |= F_BLANK; continue;
705 case '#': flags |= F_ALT; continue;
706 case '0': flags |= F_ZERO; continue;
707 }
708 break;
709 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200710
711 /* Parse width. Example: "%10s" => width=10 */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800712 if (c == '*') {
713 v = getnextarg(args, arglen, &argidx);
714 if (v == NULL)
715 goto error;
716 if (!PyLong_Check(v)) {
717 PyErr_SetString(PyExc_TypeError,
718 "* wants int");
719 goto error;
720 }
721 width = PyLong_AsSsize_t(v);
722 if (width == -1 && PyErr_Occurred())
723 goto error;
724 if (width < 0) {
725 flags |= F_LJUST;
726 width = -width;
727 }
728 if (--fmtcnt >= 0)
729 c = *fmt++;
730 }
731 else if (c >= 0 && isdigit(c)) {
732 width = c - '0';
733 while (--fmtcnt >= 0) {
734 c = Py_CHARMASK(*fmt++);
735 if (!isdigit(c))
736 break;
737 if (width > (PY_SSIZE_T_MAX - ((int)c - '0')) / 10) {
738 PyErr_SetString(
739 PyExc_ValueError,
740 "width too big");
741 goto error;
742 }
743 width = width*10 + (c - '0');
744 }
745 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200746
747 /* Parse precision. Example: "%.3f" => prec=3 */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800748 if (c == '.') {
749 prec = 0;
750 if (--fmtcnt >= 0)
751 c = *fmt++;
752 if (c == '*') {
753 v = getnextarg(args, arglen, &argidx);
754 if (v == NULL)
755 goto error;
756 if (!PyLong_Check(v)) {
757 PyErr_SetString(
758 PyExc_TypeError,
759 "* wants int");
760 goto error;
761 }
Serhiy Storchaka26861b02015-02-16 20:52:17 +0200762 prec = _PyLong_AsInt(v);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800763 if (prec == -1 && PyErr_Occurred())
764 goto error;
765 if (prec < 0)
766 prec = 0;
767 if (--fmtcnt >= 0)
768 c = *fmt++;
769 }
770 else if (c >= 0 && isdigit(c)) {
771 prec = c - '0';
772 while (--fmtcnt >= 0) {
773 c = Py_CHARMASK(*fmt++);
774 if (!isdigit(c))
775 break;
776 if (prec > (INT_MAX - ((int)c - '0')) / 10) {
777 PyErr_SetString(
778 PyExc_ValueError,
779 "prec too big");
780 goto error;
781 }
782 prec = prec*10 + (c - '0');
783 }
784 }
785 } /* prec */
786 if (fmtcnt >= 0) {
787 if (c == 'h' || c == 'l' || c == 'L') {
788 if (--fmtcnt >= 0)
789 c = *fmt++;
790 }
791 }
792 if (fmtcnt < 0) {
793 PyErr_SetString(PyExc_ValueError,
794 "incomplete format");
795 goto error;
796 }
797 if (c != '%') {
798 v = getnextarg(args, arglen, &argidx);
799 if (v == NULL)
800 goto error;
801 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200802
803 if (fmtcnt < 0) {
804 /* last writer: disable writer overallocation */
805 writer.overallocate = 0;
806 }
807
Ethan Furmanb95b5612015-01-23 20:05:18 -0800808 sign = 0;
809 fill = ' ';
810 switch (c) {
811 case '%':
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200812 *res++ = '%';
813 continue;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200814
Ethan Furman62e977f2015-03-11 08:17:00 -0700815 case 'r':
816 // %r is only for 2/3 code; 3 only code should use %a
Ethan Furmanb95b5612015-01-23 20:05:18 -0800817 case 'a':
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200818 temp = PyObject_ASCII(v);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800819 if (temp == NULL)
820 goto error;
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200821 assert(PyUnicode_IS_ASCII(temp));
822 pbuf = (const char *)PyUnicode_1BYTE_DATA(temp);
823 len = PyUnicode_GET_LENGTH(temp);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800824 if (prec >= 0 && len > prec)
825 len = prec;
826 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200827
Ethan Furmanb95b5612015-01-23 20:05:18 -0800828 case 's':
829 // %s is only for 2/3 code; 3 only code should use %b
830 case 'b':
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200831 temp = format_obj(v, &pbuf, &len);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800832 if (temp == NULL)
833 goto error;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800834 if (prec >= 0 && len > prec)
835 len = prec;
836 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200837
Ethan Furmanb95b5612015-01-23 20:05:18 -0800838 case 'i':
839 case 'd':
840 case 'u':
841 case 'o':
842 case 'x':
843 case 'X':
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200844 if (PyLong_CheckExact(v)
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200845 && width == -1 && prec == -1
846 && !(flags & (F_SIGN | F_BLANK))
847 && c != 'X')
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200848 {
849 /* Fast path */
850 int alternate = flags & F_ALT;
851 int base;
852
853 switch(c)
854 {
855 default:
856 assert(0 && "'type' not in [diuoxX]");
857 case 'd':
858 case 'i':
859 case 'u':
860 base = 10;
861 break;
862 case 'o':
863 base = 8;
864 break;
865 case 'x':
866 case 'X':
867 base = 16;
868 break;
869 }
870
871 /* Fast path */
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200872 writer.min_size -= 2; /* size preallocated for "%d" */
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200873 res = _PyLong_FormatBytesWriter(&writer, res,
874 v, base, alternate);
875 if (res == NULL)
876 goto error;
877 continue;
878 }
879
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300880 temp = formatlong(v, flags, prec, c);
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200881 if (!temp)
882 goto error;
883 assert(PyUnicode_IS_ASCII(temp));
884 pbuf = (const char *)PyUnicode_1BYTE_DATA(temp);
885 len = PyUnicode_GET_LENGTH(temp);
886 sign = 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800887 if (flags & F_ZERO)
888 fill = '0';
889 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200890
Ethan Furmanb95b5612015-01-23 20:05:18 -0800891 case 'e':
892 case 'E':
893 case 'f':
894 case 'F':
895 case 'g':
896 case 'G':
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200897 if (width == -1 && prec == -1
898 && !(flags & (F_SIGN | F_BLANK)))
899 {
900 /* Fast path */
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200901 writer.min_size -= 2; /* size preallocated for "%f" */
Victor Stinnerad771582015-10-09 12:38:53 +0200902 res = formatfloat(v, flags, prec, c, NULL, &writer, res);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200903 if (res == NULL)
904 goto error;
905 continue;
906 }
907
Victor Stinnerad771582015-10-09 12:38:53 +0200908 if (!formatfloat(v, flags, prec, c, &temp, NULL, res))
Ethan Furmanb95b5612015-01-23 20:05:18 -0800909 goto error;
910 pbuf = PyBytes_AS_STRING(temp);
911 len = PyBytes_GET_SIZE(temp);
912 sign = 1;
913 if (flags & F_ZERO)
914 fill = '0';
915 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200916
Ethan Furmanb95b5612015-01-23 20:05:18 -0800917 case 'c':
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200918 pbuf = &onechar;
919 len = byte_converter(v, &onechar);
920 if (!len)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800921 goto error;
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200922 if (width == -1) {
923 /* Fast path */
924 *res++ = onechar;
925 continue;
926 }
Ethan Furmanb95b5612015-01-23 20:05:18 -0800927 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200928
Ethan Furmanb95b5612015-01-23 20:05:18 -0800929 default:
930 PyErr_Format(PyExc_ValueError,
931 "unsupported format character '%c' (0x%x) "
932 "at index %zd",
933 c, c,
Victor Stinner772b2b02015-10-14 09:56:53 +0200934 (Py_ssize_t)(fmt - 1 - format));
Ethan Furmanb95b5612015-01-23 20:05:18 -0800935 goto error;
936 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200937
Ethan Furmanb95b5612015-01-23 20:05:18 -0800938 if (sign) {
939 if (*pbuf == '-' || *pbuf == '+') {
940 sign = *pbuf++;
941 len--;
942 }
943 else if (flags & F_SIGN)
944 sign = '+';
945 else if (flags & F_BLANK)
946 sign = ' ';
947 else
948 sign = 0;
949 }
950 if (width < len)
951 width = len;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200952
953 alloc = width;
954 if (sign != 0 && len == width)
955 alloc++;
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200956 /* 2: size preallocated for %s */
957 if (alloc > 2) {
958 res = _PyBytesWriter_Prepare(&writer, res, alloc - 2);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200959 if (res == NULL)
960 goto error;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800961 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200962#ifdef Py_DEBUG
963 before = res;
964#endif
965
966 /* Write the sign if needed */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800967 if (sign) {
968 if (fill != ' ')
969 *res++ = sign;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800970 if (width > len)
971 width--;
972 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200973
974 /* Write the numeric prefix for "x", "X" and "o" formats
975 if the alternate form is used.
976 For example, write "0x" for the "%#x" format. */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800977 if ((flags & F_ALT) && (c == 'x' || c == 'X')) {
978 assert(pbuf[0] == '0');
979 assert(pbuf[1] == c);
980 if (fill != ' ') {
981 *res++ = *pbuf++;
982 *res++ = *pbuf++;
983 }
Ethan Furmanb95b5612015-01-23 20:05:18 -0800984 width -= 2;
985 if (width < 0)
986 width = 0;
987 len -= 2;
988 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200989
990 /* Pad left with the fill character if needed */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800991 if (width > len && !(flags & F_LJUST)) {
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200992 memset(res, fill, width - len);
993 res += (width - len);
994 width = len;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800995 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200996
997 /* If padding with spaces: write sign if needed and/or numeric
998 prefix if the alternate form is used */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800999 if (fill == ' ') {
1000 if (sign)
1001 *res++ = sign;
1002 if ((flags & F_ALT) &&
1003 (c == 'x' || c == 'X')) {
1004 assert(pbuf[0] == '0');
1005 assert(pbuf[1] == c);
1006 *res++ = *pbuf++;
1007 *res++ = *pbuf++;
1008 }
1009 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001010
1011 /* Copy bytes */
Christian Heimesf051e432016-09-13 20:22:02 +02001012 memcpy(res, pbuf, len);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001013 res += len;
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001014
1015 /* Pad right with the fill character if needed */
1016 if (width > len) {
1017 memset(res, ' ', width - len);
1018 res += (width - len);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001019 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001020
Ethan Furmanb95b5612015-01-23 20:05:18 -08001021 if (dict && (argidx < arglen) && c != '%') {
1022 PyErr_SetString(PyExc_TypeError,
1023 "not all arguments converted during bytes formatting");
Ethan Furmanb95b5612015-01-23 20:05:18 -08001024 Py_XDECREF(temp);
1025 goto error;
1026 }
Ethan Furmanb95b5612015-01-23 20:05:18 -08001027 Py_XDECREF(temp);
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001028
1029#ifdef Py_DEBUG
1030 /* check that we computed the exact size for this write */
1031 assert((res - before) == alloc);
1032#endif
Ethan Furmanb95b5612015-01-23 20:05:18 -08001033 } /* '%' */
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001034
1035 /* If overallocation was disabled, ensure that it was the last
1036 write. Otherwise, we missed an optimization */
Victor Stinner772b2b02015-10-14 09:56:53 +02001037 assert(writer.overallocate || fmtcnt < 0 || use_bytearray);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001038 } /* until end */
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001039
Ethan Furmanb95b5612015-01-23 20:05:18 -08001040 if (argidx < arglen && !dict) {
1041 PyErr_SetString(PyExc_TypeError,
1042 "not all arguments converted during bytes formatting");
1043 goto error;
1044 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001045
Ethan Furmanb95b5612015-01-23 20:05:18 -08001046 if (args_owned) {
1047 Py_DECREF(args);
1048 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001049 return _PyBytesWriter_Finish(&writer, res);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001050
1051 error:
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001052 _PyBytesWriter_Dealloc(&writer);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001053 if (args_owned) {
1054 Py_DECREF(args);
1055 }
1056 return NULL;
1057}
1058
1059/* =-= */
1060
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001061static void
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001062bytes_dealloc(PyObject *op)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001063{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001064 Py_TYPE(op)->tp_free(op);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001065}
1066
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001067/* Unescape a backslash-escaped string. If unicode is non-zero,
1068 the string is a u-literal. If recode_encoding is non-zero,
1069 the string is UTF-8 encoded and should be re-encoded in the
1070 specified encoding. */
1071
Victor Stinner2ec80632015-10-14 13:32:13 +02001072static char *
1073_PyBytes_DecodeEscapeRecode(const char **s, const char *end,
1074 const char *errors, const char *recode_encoding,
1075 _PyBytesWriter *writer, char *p)
1076{
1077 PyObject *u, *w;
1078 const char* t;
1079
1080 t = *s;
1081 /* Decode non-ASCII bytes as UTF-8. */
1082 while (t < end && (*t & 0x80))
1083 t++;
1084 u = PyUnicode_DecodeUTF8(*s, t - *s, errors);
1085 if (u == NULL)
1086 return NULL;
1087
1088 /* Recode them in target encoding. */
1089 w = PyUnicode_AsEncodedString(u, recode_encoding, errors);
1090 Py_DECREF(u);
1091 if (w == NULL)
1092 return NULL;
1093 assert(PyBytes_Check(w));
1094
1095 /* Append bytes to output buffer. */
Raymond Hettinger15f44ab2016-08-30 10:47:49 -07001096 writer->min_size--; /* subtract 1 preallocated byte */
Victor Stinner2ec80632015-10-14 13:32:13 +02001097 p = _PyBytesWriter_WriteBytes(writer, p,
1098 PyBytes_AS_STRING(w),
1099 PyBytes_GET_SIZE(w));
1100 Py_DECREF(w);
1101 if (p == NULL)
1102 return NULL;
1103
1104 *s = t;
1105 return p;
1106}
1107
Eric V. Smith42454af2016-10-31 09:22:08 -04001108PyObject *_PyBytes_DecodeEscape(const char *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001109 Py_ssize_t len,
1110 const char *errors,
1111 Py_ssize_t unicode,
Eric V. Smith42454af2016-10-31 09:22:08 -04001112 const char *recode_encoding,
1113 const char **first_invalid_escape)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001114{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001115 int c;
Victor Stinner2ec80632015-10-14 13:32:13 +02001116 char *p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001117 const char *end;
Victor Stinner2ec80632015-10-14 13:32:13 +02001118 _PyBytesWriter writer;
1119
1120 _PyBytesWriter_Init(&writer);
1121
1122 p = _PyBytesWriter_Alloc(&writer, len);
1123 if (p == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001124 return NULL;
Victor Stinner2ec80632015-10-14 13:32:13 +02001125 writer.overallocate = 1;
1126
Eric V. Smith42454af2016-10-31 09:22:08 -04001127 *first_invalid_escape = NULL;
1128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001129 end = s + len;
1130 while (s < end) {
1131 if (*s != '\\') {
1132 non_esc:
Victor Stinner2ec80632015-10-14 13:32:13 +02001133 if (!(recode_encoding && (*s & 0x80))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001134 *p++ = *s++;
1135 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001136 else {
1137 /* non-ASCII character and need to recode */
1138 p = _PyBytes_DecodeEscapeRecode(&s, end,
1139 errors, recode_encoding,
1140 &writer, p);
1141 if (p == NULL)
1142 goto failed;
1143 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001144 continue;
1145 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001146
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001147 s++;
Victor Stinner2ec80632015-10-14 13:32:13 +02001148 if (s == end) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001149 PyErr_SetString(PyExc_ValueError,
1150 "Trailing \\ in string");
1151 goto failed;
1152 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001153
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001154 switch (*s++) {
1155 /* XXX This assumes ASCII! */
1156 case '\n': break;
1157 case '\\': *p++ = '\\'; break;
1158 case '\'': *p++ = '\''; break;
1159 case '\"': *p++ = '\"'; break;
1160 case 'b': *p++ = '\b'; break;
1161 case 'f': *p++ = '\014'; break; /* FF */
1162 case 't': *p++ = '\t'; break;
1163 case 'n': *p++ = '\n'; break;
1164 case 'r': *p++ = '\r'; break;
1165 case 'v': *p++ = '\013'; break; /* VT */
1166 case 'a': *p++ = '\007'; break; /* BEL, not classic C */
1167 case '0': case '1': case '2': case '3':
1168 case '4': case '5': case '6': case '7':
1169 c = s[-1] - '0';
1170 if (s < end && '0' <= *s && *s <= '7') {
1171 c = (c<<3) + *s++ - '0';
1172 if (s < end && '0' <= *s && *s <= '7')
1173 c = (c<<3) + *s++ - '0';
1174 }
1175 *p++ = c;
1176 break;
1177 case 'x':
Victor Stinner2ec80632015-10-14 13:32:13 +02001178 if (s+1 < end) {
1179 int digit1, digit2;
1180 digit1 = _PyLong_DigitValue[Py_CHARMASK(s[0])];
1181 digit2 = _PyLong_DigitValue[Py_CHARMASK(s[1])];
1182 if (digit1 < 16 && digit2 < 16) {
1183 *p++ = (unsigned char)((digit1 << 4) + digit2);
1184 s += 2;
1185 break;
1186 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001187 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001188 /* invalid hexadecimal digits */
1189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001190 if (!errors || strcmp(errors, "strict") == 0) {
Serhiy Storchaka5e61f142013-02-10 17:36:00 +02001191 PyErr_Format(PyExc_ValueError,
1192 "invalid \\x escape at position %d",
Serhiy Storchaka801d9552013-02-10 17:42:01 +02001193 s - 2 - (end - len));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001194 goto failed;
1195 }
1196 if (strcmp(errors, "replace") == 0) {
1197 *p++ = '?';
1198 } else if (strcmp(errors, "ignore") == 0)
1199 /* do nothing */;
1200 else {
1201 PyErr_Format(PyExc_ValueError,
1202 "decoding error; unknown "
1203 "error handling code: %.400s",
1204 errors);
1205 goto failed;
1206 }
Serhiy Storchakaace3ad32013-01-25 23:31:43 +02001207 /* skip \x */
1208 if (s < end && Py_ISXDIGIT(s[0]))
1209 s++; /* and a hexdigit */
1210 break;
Victor Stinner2ec80632015-10-14 13:32:13 +02001211
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001212 default:
Eric V. Smith42454af2016-10-31 09:22:08 -04001213 if (*first_invalid_escape == NULL) {
1214 *first_invalid_escape = s-1; /* Back up one char, since we've
1215 already incremented s. */
1216 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001217 *p++ = '\\';
Eric V. Smith42454af2016-10-31 09:22:08 -04001218 s--;
Ezio Melotti42da6632011-03-15 05:18:48 +02001219 goto non_esc; /* an arbitrary number of unescaped
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001220 UTF-8 bytes may follow. */
1221 }
1222 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001223
1224 return _PyBytesWriter_Finish(&writer, p);
1225
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001226 failed:
Victor Stinner2ec80632015-10-14 13:32:13 +02001227 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001228 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001229}
1230
Eric V. Smith42454af2016-10-31 09:22:08 -04001231PyObject *PyBytes_DecodeEscape(const char *s,
1232 Py_ssize_t len,
1233 const char *errors,
1234 Py_ssize_t unicode,
1235 const char *recode_encoding)
1236{
1237 const char* first_invalid_escape;
1238 PyObject *result = _PyBytes_DecodeEscape(s, len, errors, unicode,
1239 recode_encoding,
1240 &first_invalid_escape);
1241 if (result == NULL)
1242 return NULL;
1243 if (first_invalid_escape != NULL) {
1244 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1245 "invalid escape sequence '\\%c'",
1246 *first_invalid_escape) < 0) {
1247 Py_DECREF(result);
1248 return NULL;
1249 }
1250 }
1251 return result;
1252
1253}
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001254/* -------------------------------------------------------------------- */
1255/* object api */
1256
1257Py_ssize_t
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001258PyBytes_Size(PyObject *op)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001259{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001260 if (!PyBytes_Check(op)) {
1261 PyErr_Format(PyExc_TypeError,
1262 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
1263 return -1;
1264 }
1265 return Py_SIZE(op);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001266}
1267
1268char *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001269PyBytes_AsString(PyObject *op)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001270{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001271 if (!PyBytes_Check(op)) {
1272 PyErr_Format(PyExc_TypeError,
1273 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
1274 return NULL;
1275 }
1276 return ((PyBytesObject *)op)->ob_sval;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001277}
1278
1279int
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001280PyBytes_AsStringAndSize(PyObject *obj,
1281 char **s,
1282 Py_ssize_t *len)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001283{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001284 if (s == NULL) {
1285 PyErr_BadInternalCall();
1286 return -1;
1287 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001288
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001289 if (!PyBytes_Check(obj)) {
1290 PyErr_Format(PyExc_TypeError,
1291 "expected bytes, %.200s found", Py_TYPE(obj)->tp_name);
1292 return -1;
1293 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001294
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001295 *s = PyBytes_AS_STRING(obj);
1296 if (len != NULL)
1297 *len = PyBytes_GET_SIZE(obj);
1298 else if (strlen(*s) != (size_t)PyBytes_GET_SIZE(obj)) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001299 PyErr_SetString(PyExc_ValueError,
1300 "embedded null byte");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001301 return -1;
1302 }
1303 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001304}
Neal Norwitz6968b052007-02-27 19:02:19 +00001305
1306/* -------------------------------------------------------------------- */
1307/* Methods */
1308
Eric Smith0923d1d2009-04-16 20:16:10 +00001309#include "stringlib/stringdefs.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001310
1311#include "stringlib/fastsearch.h"
1312#include "stringlib/count.h"
1313#include "stringlib/find.h"
Antoine Pitroucfc22b42012-10-16 21:07:23 +02001314#include "stringlib/join.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001315#include "stringlib/partition.h"
Antoine Pitrouf2c54842010-01-13 08:07:53 +00001316#include "stringlib/split.h"
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001317#include "stringlib/ctype.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001318
Eric Smith0f78bff2009-11-30 01:01:42 +00001319#include "stringlib/transmogrify.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001320
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001321PyObject *
1322PyBytes_Repr(PyObject *obj, int smartquotes)
Neal Norwitz6968b052007-02-27 19:02:19 +00001323{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001324 PyBytesObject* op = (PyBytesObject*) obj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001325 Py_ssize_t i, length = Py_SIZE(op);
Benjamin Petersond48bc942014-09-29 19:12:26 -04001326 Py_ssize_t newsize, squotes, dquotes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001327 PyObject *v;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001328 unsigned char quote, *s, *p;
1329
1330 /* Compute size of output string */
1331 squotes = dquotes = 0;
1332 newsize = 3; /* b'' */
1333 s = (unsigned char*)op->ob_sval;
1334 for (i = 0; i < length; i++) {
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001335 Py_ssize_t incr = 1;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001336 switch(s[i]) {
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001337 case '\'': squotes++; break;
1338 case '"': dquotes++; break;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001339 case '\\': case '\t': case '\n': case '\r':
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001340 incr = 2; break; /* \C */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001341 default:
1342 if (s[i] < ' ' || s[i] >= 0x7f)
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001343 incr = 4; /* \xHH */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001344 }
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001345 if (newsize > PY_SSIZE_T_MAX - incr)
1346 goto overflow;
1347 newsize += incr;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001348 }
1349 quote = '\'';
1350 if (smartquotes && squotes && !dquotes)
1351 quote = '"';
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001352 if (squotes && quote == '\'') {
1353 if (newsize > PY_SSIZE_T_MAX - squotes)
1354 goto overflow;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001355 newsize += squotes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001356 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001357
1358 v = PyUnicode_New(newsize, 127);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001359 if (v == NULL) {
1360 return NULL;
1361 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001362 p = PyUnicode_1BYTE_DATA(v);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001363
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001364 *p++ = 'b', *p++ = quote;
1365 for (i = 0; i < length; i++) {
1366 unsigned char c = op->ob_sval[i];
1367 if (c == quote || c == '\\')
1368 *p++ = '\\', *p++ = c;
1369 else if (c == '\t')
1370 *p++ = '\\', *p++ = 't';
1371 else if (c == '\n')
1372 *p++ = '\\', *p++ = 'n';
1373 else if (c == '\r')
1374 *p++ = '\\', *p++ = 'r';
1375 else if (c < ' ' || c >= 0x7f) {
1376 *p++ = '\\';
1377 *p++ = 'x';
Victor Stinnerf5cff562011-10-14 02:13:11 +02001378 *p++ = Py_hexdigits[(c & 0xf0) >> 4];
1379 *p++ = Py_hexdigits[c & 0xf];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001381 else
1382 *p++ = c;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001383 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001384 *p++ = quote;
Victor Stinner8f825062012-04-27 13:55:39 +02001385 assert(_PyUnicode_CheckConsistency(v, 1));
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001386 return v;
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001387
1388 overflow:
1389 PyErr_SetString(PyExc_OverflowError,
1390 "bytes object is too large to make repr");
1391 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001392}
1393
Neal Norwitz6968b052007-02-27 19:02:19 +00001394static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001395bytes_repr(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001396{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001397 return PyBytes_Repr(op, 1);
Neal Norwitz6968b052007-02-27 19:02:19 +00001398}
1399
Neal Norwitz6968b052007-02-27 19:02:19 +00001400static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001401bytes_str(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001402{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001403 if (Py_BytesWarningFlag) {
1404 if (PyErr_WarnEx(PyExc_BytesWarning,
1405 "str() on a bytes instance", 1))
1406 return NULL;
1407 }
1408 return bytes_repr(op);
Neal Norwitz6968b052007-02-27 19:02:19 +00001409}
1410
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001411static Py_ssize_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001412bytes_length(PyBytesObject *a)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001413{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001414 return Py_SIZE(a);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001415}
Neal Norwitz6968b052007-02-27 19:02:19 +00001416
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001417/* This is also used by PyBytes_Concat() */
1418static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001419bytes_concat(PyObject *a, PyObject *b)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001420{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001421 Py_buffer va, vb;
1422 PyObject *result = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001423
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 va.len = -1;
1425 vb.len = -1;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001426 if (PyObject_GetBuffer(a, &va, PyBUF_SIMPLE) != 0 ||
1427 PyObject_GetBuffer(b, &vb, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
1429 Py_TYPE(a)->tp_name, Py_TYPE(b)->tp_name);
1430 goto done;
1431 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001432
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001433 /* Optimize end cases */
1434 if (va.len == 0 && PyBytes_CheckExact(b)) {
1435 result = b;
1436 Py_INCREF(result);
1437 goto done;
1438 }
1439 if (vb.len == 0 && PyBytes_CheckExact(a)) {
1440 result = a;
1441 Py_INCREF(result);
1442 goto done;
1443 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001444
Serhiy Storchaka06cfb0c2016-07-10 20:48:43 +03001445 if (va.len > PY_SSIZE_T_MAX - vb.len) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 PyErr_NoMemory();
1447 goto done;
1448 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001449
Serhiy Storchaka06cfb0c2016-07-10 20:48:43 +03001450 result = PyBytes_FromStringAndSize(NULL, va.len + vb.len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 if (result != NULL) {
1452 memcpy(PyBytes_AS_STRING(result), va.buf, va.len);
1453 memcpy(PyBytes_AS_STRING(result) + va.len, vb.buf, vb.len);
1454 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001455
1456 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001457 if (va.len != -1)
1458 PyBuffer_Release(&va);
1459 if (vb.len != -1)
1460 PyBuffer_Release(&vb);
1461 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001462}
Neal Norwitz6968b052007-02-27 19:02:19 +00001463
1464static PyObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001465bytes_repeat(PyBytesObject *a, Py_ssize_t n)
Neal Norwitz6968b052007-02-27 19:02:19 +00001466{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001467 Py_ssize_t i;
1468 Py_ssize_t j;
1469 Py_ssize_t size;
1470 PyBytesObject *op;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001471 size_t nbytes;
1472 if (n < 0)
1473 n = 0;
1474 /* watch out for overflows: the size can overflow int,
1475 * and the # of bytes needed can overflow size_t
1476 */
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001477 if (n > 0 && Py_SIZE(a) > PY_SSIZE_T_MAX / n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001478 PyErr_SetString(PyExc_OverflowError,
1479 "repeated bytes are too long");
1480 return NULL;
1481 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001482 size = Py_SIZE(a) * n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001483 if (size == Py_SIZE(a) && PyBytes_CheckExact(a)) {
1484 Py_INCREF(a);
1485 return (PyObject *)a;
1486 }
1487 nbytes = (size_t)size;
1488 if (nbytes + PyBytesObject_SIZE <= nbytes) {
1489 PyErr_SetString(PyExc_OverflowError,
1490 "repeated bytes are too long");
1491 return NULL;
1492 }
1493 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + nbytes);
1494 if (op == NULL)
1495 return PyErr_NoMemory();
Christian Heimesd3afe782013-12-04 09:27:47 +01001496 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001497 op->ob_shash = -1;
1498 op->ob_sval[size] = '\0';
1499 if (Py_SIZE(a) == 1 && n > 0) {
1500 memset(op->ob_sval, a->ob_sval[0] , n);
1501 return (PyObject *) op;
1502 }
1503 i = 0;
1504 if (i < size) {
Christian Heimesf051e432016-09-13 20:22:02 +02001505 memcpy(op->ob_sval, a->ob_sval, Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 i = Py_SIZE(a);
1507 }
1508 while (i < size) {
1509 j = (i <= size-i) ? i : size-i;
Christian Heimesf051e432016-09-13 20:22:02 +02001510 memcpy(op->ob_sval+i, op->ob_sval, j);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001511 i += j;
1512 }
1513 return (PyObject *) op;
Neal Norwitz6968b052007-02-27 19:02:19 +00001514}
1515
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001516static int
1517bytes_contains(PyObject *self, PyObject *arg)
1518{
1519 return _Py_bytes_contains(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), arg);
1520}
1521
Neal Norwitz6968b052007-02-27 19:02:19 +00001522static PyObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001523bytes_item(PyBytesObject *a, Py_ssize_t i)
Neal Norwitz6968b052007-02-27 19:02:19 +00001524{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001525 if (i < 0 || i >= Py_SIZE(a)) {
1526 PyErr_SetString(PyExc_IndexError, "index out of range");
1527 return NULL;
1528 }
1529 return PyLong_FromLong((unsigned char)a->ob_sval[i]);
Neal Norwitz6968b052007-02-27 19:02:19 +00001530}
1531
Benjamin Peterson621b4302016-09-09 13:54:34 -07001532static int
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001533bytes_compare_eq(PyBytesObject *a, PyBytesObject *b)
1534{
1535 int cmp;
1536 Py_ssize_t len;
1537
1538 len = Py_SIZE(a);
1539 if (Py_SIZE(b) != len)
1540 return 0;
1541
1542 if (a->ob_sval[0] != b->ob_sval[0])
1543 return 0;
1544
1545 cmp = memcmp(a->ob_sval, b->ob_sval, len);
1546 return (cmp == 0);
1547}
1548
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001549static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001550bytes_richcompare(PyBytesObject *a, PyBytesObject *b, int op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001551{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001552 int c;
1553 Py_ssize_t len_a, len_b;
1554 Py_ssize_t min_len;
1555 PyObject *result;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001556 int rc;
Neal Norwitz6968b052007-02-27 19:02:19 +00001557
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001558 /* Make sure both arguments are strings. */
1559 if (!(PyBytes_Check(a) && PyBytes_Check(b))) {
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001560 if (Py_BytesWarningFlag && (op == Py_EQ || op == Py_NE)) {
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001561 rc = PyObject_IsInstance((PyObject*)a,
1562 (PyObject*)&PyUnicode_Type);
1563 if (!rc)
1564 rc = PyObject_IsInstance((PyObject*)b,
1565 (PyObject*)&PyUnicode_Type);
1566 if (rc < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001567 return NULL;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001568 if (rc) {
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001569 if (PyErr_WarnEx(PyExc_BytesWarning,
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001570 "Comparison between bytes and string", 1))
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001571 return NULL;
1572 }
Serhiy Storchakaac5569b2015-05-30 17:48:19 +03001573 else {
1574 rc = PyObject_IsInstance((PyObject*)a,
1575 (PyObject*)&PyLong_Type);
1576 if (!rc)
1577 rc = PyObject_IsInstance((PyObject*)b,
1578 (PyObject*)&PyLong_Type);
1579 if (rc < 0)
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001580 return NULL;
Serhiy Storchakaac5569b2015-05-30 17:48:19 +03001581 if (rc) {
1582 if (PyErr_WarnEx(PyExc_BytesWarning,
1583 "Comparison between bytes and int", 1))
1584 return NULL;
1585 }
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001586 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001587 }
1588 result = Py_NotImplemented;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001589 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001590 else if (a == b) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001591 switch (op) {
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001592 case Py_EQ:
1593 case Py_LE:
1594 case Py_GE:
1595 /* a string is equal to itself */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001596 result = Py_True;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001597 break;
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001598 case Py_NE:
1599 case Py_LT:
1600 case Py_GT:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001601 result = Py_False;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001602 break;
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001603 default:
1604 PyErr_BadArgument();
1605 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001606 }
1607 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001608 else if (op == Py_EQ || op == Py_NE) {
1609 int eq = bytes_compare_eq(a, b);
1610 eq ^= (op == Py_NE);
1611 result = eq ? Py_True : Py_False;
1612 }
1613 else {
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001614 len_a = Py_SIZE(a);
1615 len_b = Py_SIZE(b);
1616 min_len = Py_MIN(len_a, len_b);
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001617 if (min_len > 0) {
1618 c = Py_CHARMASK(*a->ob_sval) - Py_CHARMASK(*b->ob_sval);
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001619 if (c == 0)
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001620 c = memcmp(a->ob_sval, b->ob_sval, min_len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001621 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001622 else
1623 c = 0;
1624 if (c == 0)
1625 c = (len_a < len_b) ? -1 : (len_a > len_b) ? 1 : 0;
1626 switch (op) {
1627 case Py_LT: c = c < 0; break;
1628 case Py_LE: c = c <= 0; break;
1629 case Py_GT: c = c > 0; break;
1630 case Py_GE: c = c >= 0; break;
1631 default:
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001632 PyErr_BadArgument();
1633 return NULL;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001634 }
1635 result = c ? Py_True : Py_False;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001636 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001637
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001638 Py_INCREF(result);
1639 return result;
Neal Norwitz6968b052007-02-27 19:02:19 +00001640}
1641
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001642static Py_hash_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001643bytes_hash(PyBytesObject *a)
Neal Norwitz6968b052007-02-27 19:02:19 +00001644{
Antoine Pitrouce4a9da2011-11-21 20:46:33 +01001645 if (a->ob_shash == -1) {
1646 /* Can't fail */
Christian Heimes985ecdc2013-11-20 11:46:18 +01001647 a->ob_shash = _Py_HashBytes(a->ob_sval, Py_SIZE(a));
Antoine Pitrouce4a9da2011-11-21 20:46:33 +01001648 }
1649 return a->ob_shash;
Neal Norwitz6968b052007-02-27 19:02:19 +00001650}
1651
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001652static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001653bytes_subscript(PyBytesObject* self, PyObject* item)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001654{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001655 if (PyIndex_Check(item)) {
1656 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1657 if (i == -1 && PyErr_Occurred())
1658 return NULL;
1659 if (i < 0)
1660 i += PyBytes_GET_SIZE(self);
1661 if (i < 0 || i >= PyBytes_GET_SIZE(self)) {
1662 PyErr_SetString(PyExc_IndexError,
1663 "index out of range");
1664 return NULL;
1665 }
1666 return PyLong_FromLong((unsigned char)self->ob_sval[i]);
1667 }
1668 else if (PySlice_Check(item)) {
1669 Py_ssize_t start, stop, step, slicelength, cur, i;
1670 char* source_buf;
1671 char* result_buf;
1672 PyObject* result;
Neal Norwitz6968b052007-02-27 19:02:19 +00001673
Martin v. Löwis4d0d4712010-12-03 20:14:31 +00001674 if (PySlice_GetIndicesEx(item,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001675 PyBytes_GET_SIZE(self),
1676 &start, &stop, &step, &slicelength) < 0) {
1677 return NULL;
1678 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001679
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001680 if (slicelength <= 0) {
1681 return PyBytes_FromStringAndSize("", 0);
1682 }
1683 else if (start == 0 && step == 1 &&
1684 slicelength == PyBytes_GET_SIZE(self) &&
1685 PyBytes_CheckExact(self)) {
1686 Py_INCREF(self);
1687 return (PyObject *)self;
1688 }
1689 else if (step == 1) {
1690 return PyBytes_FromStringAndSize(
1691 PyBytes_AS_STRING(self) + start,
1692 slicelength);
1693 }
1694 else {
1695 source_buf = PyBytes_AS_STRING(self);
1696 result = PyBytes_FromStringAndSize(NULL, slicelength);
1697 if (result == NULL)
1698 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001699
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001700 result_buf = PyBytes_AS_STRING(result);
1701 for (cur = start, i = 0; i < slicelength;
1702 cur += step, i++) {
1703 result_buf[i] = source_buf[cur];
1704 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001705
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001706 return result;
1707 }
1708 }
1709 else {
1710 PyErr_Format(PyExc_TypeError,
Terry Jan Reedyffff1442014-08-02 01:30:37 -04001711 "byte indices must be integers or slices, not %.200s",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001712 Py_TYPE(item)->tp_name);
1713 return NULL;
1714 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001715}
1716
1717static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001718bytes_buffer_getbuffer(PyBytesObject *self, Py_buffer *view, int flags)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001719{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001720 return PyBuffer_FillInfo(view, (PyObject*)self, (void *)self->ob_sval, Py_SIZE(self),
1721 1, flags);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001722}
1723
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001724static PySequenceMethods bytes_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001725 (lenfunc)bytes_length, /*sq_length*/
1726 (binaryfunc)bytes_concat, /*sq_concat*/
1727 (ssizeargfunc)bytes_repeat, /*sq_repeat*/
1728 (ssizeargfunc)bytes_item, /*sq_item*/
1729 0, /*sq_slice*/
1730 0, /*sq_ass_item*/
1731 0, /*sq_ass_slice*/
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001732 (objobjproc)bytes_contains /*sq_contains*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001733};
1734
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001735static PyMappingMethods bytes_as_mapping = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 (lenfunc)bytes_length,
1737 (binaryfunc)bytes_subscript,
1738 0,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001739};
1740
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001741static PyBufferProcs bytes_as_buffer = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001742 (getbufferproc)bytes_buffer_getbuffer,
1743 NULL,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001744};
1745
1746
1747#define LEFTSTRIP 0
1748#define RIGHTSTRIP 1
1749#define BOTHSTRIP 2
1750
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001751/*[clinic input]
1752bytes.split
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001753
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001754 sep: object = None
1755 The delimiter according which to split the bytes.
1756 None (the default value) means split on ASCII whitespace characters
1757 (space, tab, return, newline, formfeed, vertical tab).
1758 maxsplit: Py_ssize_t = -1
1759 Maximum number of splits to do.
1760 -1 (the default value) means no limit.
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001761
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001762Return a list of the sections in the bytes, using sep as the delimiter.
1763[clinic start generated code]*/
1764
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001765static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001766bytes_split_impl(PyBytesObject *self, PyObject *sep, Py_ssize_t maxsplit)
1767/*[clinic end generated code: output=52126b5844c1d8ef input=8b809b39074abbfa]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001768{
1769 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001770 const char *s = PyBytes_AS_STRING(self), *sub;
1771 Py_buffer vsub;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001772 PyObject *list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001774 if (maxsplit < 0)
1775 maxsplit = PY_SSIZE_T_MAX;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001776 if (sep == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001777 return stringlib_split_whitespace((PyObject*) self, s, len, maxsplit);
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001778 if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 return NULL;
1780 sub = vsub.buf;
1781 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001783 list = stringlib_split((PyObject*) self, s, len, sub, n, maxsplit);
1784 PyBuffer_Release(&vsub);
1785 return list;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001786}
1787
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001788/*[clinic input]
1789bytes.partition
1790
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001791 sep: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001792 /
1793
1794Partition the bytes into three parts using the given separator.
1795
1796This will search for the separator sep in the bytes. If the separator is found,
1797returns a 3-tuple containing the part before the separator, the separator
1798itself, and the part after it.
1799
1800If the separator is not found, returns a 3-tuple containing the original bytes
1801object and two empty bytes objects.
1802[clinic start generated code]*/
1803
Neal Norwitz6968b052007-02-27 19:02:19 +00001804static PyObject *
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001805bytes_partition_impl(PyBytesObject *self, Py_buffer *sep)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001806/*[clinic end generated code: output=f532b392a17ff695 input=61cca95519406099]*/
Neal Norwitz6968b052007-02-27 19:02:19 +00001807{
Neal Norwitz6968b052007-02-27 19:02:19 +00001808 return stringlib_partition(
1809 (PyObject*) self,
1810 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001811 sep->obj, (const char *)sep->buf, sep->len
Neal Norwitz6968b052007-02-27 19:02:19 +00001812 );
1813}
1814
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001815/*[clinic input]
1816bytes.rpartition
1817
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001818 sep: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001819 /
1820
1821Partition the bytes into three parts using the given separator.
1822
1823This will search for the separator sep in the bytes, starting and the end. If
1824the separator is found, returns a 3-tuple containing the part before the
1825separator, the separator itself, and the part after it.
1826
1827If the separator is not found, returns a 3-tuple containing two empty bytes
1828objects and the original bytes object.
1829[clinic start generated code]*/
1830
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001831static PyObject *
1832bytes_rpartition_impl(PyBytesObject *self, Py_buffer *sep)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001833/*[clinic end generated code: output=191b114cbb028e50 input=67f689e63a62d478]*/
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001834{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001835 return stringlib_rpartition(
1836 (PyObject*) self,
1837 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001838 sep->obj, (const char *)sep->buf, sep->len
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001839 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001840}
1841
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001842/*[clinic input]
1843bytes.rsplit = bytes.split
Neal Norwitz6968b052007-02-27 19:02:19 +00001844
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001845Return a list of the sections in the bytes, using sep as the delimiter.
1846
1847Splitting is done starting at the end of the bytes and working to the front.
1848[clinic start generated code]*/
1849
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001850static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001851bytes_rsplit_impl(PyBytesObject *self, PyObject *sep, Py_ssize_t maxsplit)
1852/*[clinic end generated code: output=ba698d9ea01e1c8f input=0f86c9f28f7d7b7b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001853{
1854 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001855 const char *s = PyBytes_AS_STRING(self), *sub;
1856 Py_buffer vsub;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001857 PyObject *list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001858
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001859 if (maxsplit < 0)
1860 maxsplit = PY_SSIZE_T_MAX;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001861 if (sep == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001862 return stringlib_rsplit_whitespace((PyObject*) self, s, len, maxsplit);
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001863 if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 return NULL;
1865 sub = vsub.buf;
1866 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001867
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 list = stringlib_rsplit((PyObject*) self, s, len, sub, n, maxsplit);
1869 PyBuffer_Release(&vsub);
1870 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001871}
1872
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001873
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001874/*[clinic input]
1875bytes.join
1876
1877 iterable_of_bytes: object
1878 /
1879
1880Concatenate any number of bytes objects.
1881
1882The bytes whose method is called is inserted in between each pair.
1883
1884The result is returned as a new bytes object.
1885
1886Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.
1887[clinic start generated code]*/
1888
Neal Norwitz6968b052007-02-27 19:02:19 +00001889static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001890bytes_join(PyBytesObject *self, PyObject *iterable_of_bytes)
1891/*[clinic end generated code: output=a046f379f626f6f8 input=7fe377b95bd549d2]*/
Neal Norwitz6968b052007-02-27 19:02:19 +00001892{
Martin v. Löwis0efea322014-07-27 17:29:17 +02001893 return stringlib_bytes_join((PyObject*)self, iterable_of_bytes);
Neal Norwitz6968b052007-02-27 19:02:19 +00001894}
1895
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001896PyObject *
1897_PyBytes_Join(PyObject *sep, PyObject *x)
1898{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001899 assert(sep != NULL && PyBytes_Check(sep));
1900 assert(x != NULL);
Martin v. Löwis0efea322014-07-27 17:29:17 +02001901 return bytes_join((PyBytesObject*)sep, x);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001902}
1903
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001904static PyObject *
1905bytes_find(PyBytesObject *self, PyObject *args)
1906{
1907 return _Py_bytes_find(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1908}
1909
1910static PyObject *
1911bytes_index(PyBytesObject *self, PyObject *args)
1912{
1913 return _Py_bytes_index(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1914}
1915
1916
1917static PyObject *
1918bytes_rfind(PyBytesObject *self, PyObject *args)
1919{
1920 return _Py_bytes_rfind(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1921}
1922
1923
1924static PyObject *
1925bytes_rindex(PyBytesObject *self, PyObject *args)
1926{
1927 return _Py_bytes_rindex(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1928}
1929
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001930
1931Py_LOCAL_INLINE(PyObject *)
1932do_xstrip(PyBytesObject *self, int striptype, PyObject *sepobj)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001933{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001934 Py_buffer vsep;
1935 char *s = PyBytes_AS_STRING(self);
1936 Py_ssize_t len = PyBytes_GET_SIZE(self);
1937 char *sep;
1938 Py_ssize_t seplen;
1939 Py_ssize_t i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001940
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001941 if (PyObject_GetBuffer(sepobj, &vsep, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001942 return NULL;
1943 sep = vsep.buf;
1944 seplen = vsep.len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001945
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001946 i = 0;
1947 if (striptype != RIGHTSTRIP) {
1948 while (i < len && memchr(sep, Py_CHARMASK(s[i]), seplen)) {
1949 i++;
1950 }
1951 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001952
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 j = len;
1954 if (striptype != LEFTSTRIP) {
1955 do {
1956 j--;
1957 } while (j >= i && memchr(sep, Py_CHARMASK(s[j]), seplen));
1958 j++;
1959 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001960
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001961 PyBuffer_Release(&vsep);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001962
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001963 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1964 Py_INCREF(self);
1965 return (PyObject*)self;
1966 }
1967 else
1968 return PyBytes_FromStringAndSize(s+i, j-i);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001969}
1970
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001971
1972Py_LOCAL_INLINE(PyObject *)
1973do_strip(PyBytesObject *self, int striptype)
1974{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001975 char *s = PyBytes_AS_STRING(self);
1976 Py_ssize_t len = PyBytes_GET_SIZE(self), i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001977
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001978 i = 0;
1979 if (striptype != RIGHTSTRIP) {
David Malcolm96960882010-11-05 17:23:41 +00001980 while (i < len && Py_ISSPACE(s[i])) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001981 i++;
1982 }
1983 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001984
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001985 j = len;
1986 if (striptype != LEFTSTRIP) {
1987 do {
1988 j--;
David Malcolm96960882010-11-05 17:23:41 +00001989 } while (j >= i && Py_ISSPACE(s[j]));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 j++;
1991 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001992
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001993 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1994 Py_INCREF(self);
1995 return (PyObject*)self;
1996 }
1997 else
1998 return PyBytes_FromStringAndSize(s+i, j-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001999}
2000
2001
2002Py_LOCAL_INLINE(PyObject *)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002003do_argstrip(PyBytesObject *self, int striptype, PyObject *bytes)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002004{
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002005 if (bytes != NULL && bytes != Py_None) {
2006 return do_xstrip(self, striptype, bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002007 }
2008 return do_strip(self, striptype);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002009}
2010
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002011/*[clinic input]
2012bytes.strip
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002013
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002014 bytes: object = None
2015 /
2016
2017Strip leading and trailing bytes contained in the argument.
2018
2019If the argument is omitted or None, strip leading and trailing ASCII whitespace.
2020[clinic start generated code]*/
2021
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002022static PyObject *
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002023bytes_strip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002024/*[clinic end generated code: output=c7c228d3bd104a1b input=8a354640e4e0b3ef]*/
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002025{
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002026 return do_argstrip(self, BOTHSTRIP, bytes);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002027}
2028
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002029/*[clinic input]
2030bytes.lstrip
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002031
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002032 bytes: object = None
2033 /
2034
2035Strip leading bytes contained in the argument.
2036
2037If the argument is omitted or None, strip leading ASCII whitespace.
2038[clinic start generated code]*/
2039
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002040static PyObject *
2041bytes_lstrip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002042/*[clinic end generated code: output=28602e586f524e82 input=9baff4398c3f6857]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002043{
2044 return do_argstrip(self, LEFTSTRIP, bytes);
2045}
2046
2047/*[clinic input]
2048bytes.rstrip
2049
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002050 bytes: object = None
2051 /
2052
2053Strip trailing bytes contained in the argument.
2054
2055If the argument is omitted or None, strip trailing ASCII whitespace.
2056[clinic start generated code]*/
2057
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002058static PyObject *
2059bytes_rstrip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002060/*[clinic end generated code: output=547e3815c95447da input=b78af445c727e32b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002061{
2062 return do_argstrip(self, RIGHTSTRIP, bytes);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002063}
Neal Norwitz6968b052007-02-27 19:02:19 +00002064
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002065
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002066static PyObject *
2067bytes_count(PyBytesObject *self, PyObject *args)
2068{
2069 return _Py_bytes_count(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2070}
2071
2072
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002073/*[clinic input]
2074bytes.translate
2075
Victor Stinner049e5092014-08-17 22:20:00 +02002076 table: object
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002077 Translation table, which must be a bytes object of length 256.
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002078 /
Martin Panter1b6c6da2016-08-27 08:35:02 +00002079 delete as deletechars: object(c_default="NULL") = b''
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002080
2081Return a copy with each character mapped by the given translation table.
2082
Martin Panter1b6c6da2016-08-27 08:35:02 +00002083All characters occurring in the optional argument delete are removed.
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002084The remaining characters are mapped through the given translation table.
2085[clinic start generated code]*/
2086
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002087static PyObject *
Martin Panter1b6c6da2016-08-27 08:35:02 +00002088bytes_translate_impl(PyBytesObject *self, PyObject *table,
Larry Hastings89964c42015-04-14 18:07:59 -04002089 PyObject *deletechars)
Martin Panter1b6c6da2016-08-27 08:35:02 +00002090/*[clinic end generated code: output=43be3437f1956211 input=0ecdf159f654233c]*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002091{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002092 char *input, *output;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002093 Py_buffer table_view = {NULL, NULL};
2094 Py_buffer del_table_view = {NULL, NULL};
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002095 const char *table_chars;
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002096 Py_ssize_t i, c, changed = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002097 PyObject *input_obj = (PyObject*)self;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002098 const char *output_start, *del_table_chars=NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002099 Py_ssize_t inlen, tablen, dellen = 0;
2100 PyObject *result;
2101 int trans_table[256];
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002102
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002103 if (PyBytes_Check(table)) {
2104 table_chars = PyBytes_AS_STRING(table);
2105 tablen = PyBytes_GET_SIZE(table);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002106 }
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002107 else if (table == Py_None) {
2108 table_chars = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002109 tablen = 256;
2110 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002111 else {
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002112 if (PyObject_GetBuffer(table, &table_view, PyBUF_SIMPLE) != 0)
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002113 return NULL;
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002114 table_chars = table_view.buf;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002115 tablen = table_view.len;
2116 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002117
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 if (tablen != 256) {
2119 PyErr_SetString(PyExc_ValueError,
2120 "translation table must be 256 characters long");
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002121 PyBuffer_Release(&table_view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002122 return NULL;
2123 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002124
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002125 if (deletechars != NULL) {
2126 if (PyBytes_Check(deletechars)) {
2127 del_table_chars = PyBytes_AS_STRING(deletechars);
2128 dellen = PyBytes_GET_SIZE(deletechars);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002129 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002130 else {
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002131 if (PyObject_GetBuffer(deletechars, &del_table_view, PyBUF_SIMPLE) != 0) {
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002132 PyBuffer_Release(&table_view);
2133 return NULL;
2134 }
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002135 del_table_chars = del_table_view.buf;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002136 dellen = del_table_view.len;
2137 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 }
2139 else {
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002140 del_table_chars = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002141 dellen = 0;
2142 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002143
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002144 inlen = PyBytes_GET_SIZE(input_obj);
2145 result = PyBytes_FromStringAndSize((char *)NULL, inlen);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002146 if (result == NULL) {
2147 PyBuffer_Release(&del_table_view);
2148 PyBuffer_Release(&table_view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 return NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002150 }
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002151 output_start = output = PyBytes_AS_STRING(result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 input = PyBytes_AS_STRING(input_obj);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002153
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002154 if (dellen == 0 && table_chars != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 /* If no deletions are required, use faster code */
2156 for (i = inlen; --i >= 0; ) {
2157 c = Py_CHARMASK(*input++);
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002158 if (Py_CHARMASK((*output++ = table_chars[c])) != c)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002159 changed = 1;
2160 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002161 if (!changed && PyBytes_CheckExact(input_obj)) {
2162 Py_INCREF(input_obj);
2163 Py_DECREF(result);
2164 result = input_obj;
2165 }
2166 PyBuffer_Release(&del_table_view);
2167 PyBuffer_Release(&table_view);
2168 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002169 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002170
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002171 if (table_chars == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002172 for (i = 0; i < 256; i++)
2173 trans_table[i] = Py_CHARMASK(i);
2174 } else {
2175 for (i = 0; i < 256; i++)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002176 trans_table[i] = Py_CHARMASK(table_chars[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002177 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002178 PyBuffer_Release(&table_view);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002179
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 for (i = 0; i < dellen; i++)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002181 trans_table[(int) Py_CHARMASK(del_table_chars[i])] = -1;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002182 PyBuffer_Release(&del_table_view);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002183
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002184 for (i = inlen; --i >= 0; ) {
2185 c = Py_CHARMASK(*input++);
2186 if (trans_table[c] != -1)
2187 if (Py_CHARMASK(*output++ = (char)trans_table[c]) == c)
2188 continue;
2189 changed = 1;
2190 }
2191 if (!changed && PyBytes_CheckExact(input_obj)) {
2192 Py_DECREF(result);
2193 Py_INCREF(input_obj);
2194 return input_obj;
2195 }
2196 /* Fix the size of the resulting string */
2197 if (inlen > 0)
2198 _PyBytes_Resize(&result, output - output_start);
2199 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002200}
2201
2202
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002203/*[clinic input]
2204
2205@staticmethod
2206bytes.maketrans
2207
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002208 frm: Py_buffer
2209 to: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002210 /
2211
2212Return a translation table useable for the bytes or bytearray translate method.
2213
2214The returned table will be one where each byte in frm is mapped to the byte at
2215the same position in to.
2216
2217The bytes objects frm and to must be of the same length.
2218[clinic start generated code]*/
2219
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002220static PyObject *
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002221bytes_maketrans_impl(Py_buffer *frm, Py_buffer *to)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03002222/*[clinic end generated code: output=a36f6399d4b77f6f input=de7a8fc5632bb8f1]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002223{
2224 return _Py_bytes_maketrans(frm, to);
Georg Brandlabc38772009-04-12 15:51:51 +00002225}
2226
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002227
2228/*[clinic input]
2229bytes.replace
2230
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002231 old: Py_buffer
2232 new: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002233 count: Py_ssize_t = -1
2234 Maximum number of occurrences to replace.
2235 -1 (the default value) means replace all occurrences.
2236 /
2237
2238Return a copy with all occurrences of substring old replaced by new.
2239
2240If the optional argument count is given, only the first count occurrences are
2241replaced.
2242[clinic start generated code]*/
2243
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002244static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002245bytes_replace_impl(PyBytesObject *self, Py_buffer *old, Py_buffer *new,
Larry Hastings89964c42015-04-14 18:07:59 -04002246 Py_ssize_t count)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002247/*[clinic end generated code: output=994fa588b6b9c104 input=b2fbbf0bf04de8e5]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002248{
Serhiy Storchakafb81d3c2016-05-05 09:26:07 +03002249 return stringlib_replace((PyObject *)self,
2250 (const char *)old->buf, old->len,
2251 (const char *)new->buf, new->len, count);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002252}
2253
2254/** End DALKE **/
2255
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002256
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002257static PyObject *
2258bytes_startswith(PyBytesObject *self, PyObject *args)
2259{
2260 return _Py_bytes_startswith(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2261}
2262
2263static PyObject *
2264bytes_endswith(PyBytesObject *self, PyObject *args)
2265{
2266 return _Py_bytes_endswith(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2267}
2268
2269
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002270/*[clinic input]
2271bytes.decode
2272
2273 encoding: str(c_default="NULL") = 'utf-8'
2274 The encoding with which to decode the bytes.
2275 errors: str(c_default="NULL") = 'strict'
2276 The error handling scheme to use for the handling of decoding errors.
2277 The default is 'strict' meaning that decoding errors raise a
2278 UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
2279 as well as any other name registered with codecs.register_error that
2280 can handle UnicodeDecodeErrors.
2281
2282Decode the bytes using the codec registered for encoding.
2283[clinic start generated code]*/
2284
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002285static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002286bytes_decode_impl(PyBytesObject *self, const char *encoding,
Larry Hastings89964c42015-04-14 18:07:59 -04002287 const char *errors)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002288/*[clinic end generated code: output=5649a53dde27b314 input=958174769d2a40ca]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002289{
Martin v. Löwis0efea322014-07-27 17:29:17 +02002290 return PyUnicode_FromEncodedObject((PyObject*)self, encoding, errors);
Guido van Rossumd624f182006-04-24 13:47:05 +00002291}
2292
Guido van Rossum20188312006-05-05 15:15:40 +00002293
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002294/*[clinic input]
2295bytes.splitlines
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002296
Serhiy Storchaka8b2e8b62015-05-30 11:30:39 +03002297 keepends: int(c_default="0") = False
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002298
2299Return a list of the lines in the bytes, breaking at line boundaries.
2300
2301Line breaks are not included in the resulting list unless keepends is given and
2302true.
2303[clinic start generated code]*/
2304
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002305static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002306bytes_splitlines_impl(PyBytesObject *self, int keepends)
2307/*[clinic end generated code: output=3484149a5d880ffb input=7f4aac67144f9944]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002308{
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002309 return stringlib_splitlines(
Antoine Pitroud1188562010-06-09 16:38:55 +00002310 (PyObject*) self, PyBytes_AS_STRING(self),
2311 PyBytes_GET_SIZE(self), keepends
2312 );
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002313}
2314
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002315/*[clinic input]
2316@classmethod
2317bytes.fromhex
2318
2319 string: unicode
2320 /
2321
2322Create a bytes object from a string of hexadecimal numbers.
2323
2324Spaces between two numbers are accepted.
2325Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.
2326[clinic start generated code]*/
2327
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002328static PyObject *
Martin v. Löwis0efea322014-07-27 17:29:17 +02002329bytes_fromhex_impl(PyTypeObject *type, PyObject *string)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03002330/*[clinic end generated code: output=0973acc63661bb2e input=bf4d1c361670acd3]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002331{
Serhiy Storchaka0855e702016-07-01 17:22:31 +03002332 PyObject *result = _PyBytes_FromHex(string, 0);
2333 if (type != &PyBytes_Type && result != NULL) {
Victor Stinner27580c12016-12-01 14:43:22 +01002334 Py_SETREF(result, _PyObject_CallArg1((PyObject *)type, result));
Serhiy Storchaka0855e702016-07-01 17:22:31 +03002335 }
2336 return result;
Victor Stinner2bf89932015-10-14 11:25:33 +02002337}
2338
2339PyObject*
2340_PyBytes_FromHex(PyObject *string, int use_bytearray)
2341{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002342 char *buf;
Victor Stinner2bf89932015-10-14 11:25:33 +02002343 Py_ssize_t hexlen, invalid_char;
2344 unsigned int top, bot;
2345 Py_UCS1 *str, *end;
2346 _PyBytesWriter writer;
2347
2348 _PyBytesWriter_Init(&writer);
2349 writer.use_bytearray = use_bytearray;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002350
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002351 assert(PyUnicode_Check(string));
2352 if (PyUnicode_READY(string))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002353 return NULL;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002354 hexlen = PyUnicode_GET_LENGTH(string);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002355
Victor Stinner2bf89932015-10-14 11:25:33 +02002356 if (!PyUnicode_IS_ASCII(string)) {
2357 void *data = PyUnicode_DATA(string);
2358 unsigned int kind = PyUnicode_KIND(string);
2359 Py_ssize_t i;
2360
2361 /* search for the first non-ASCII character */
2362 for (i = 0; i < hexlen; i++) {
2363 if (PyUnicode_READ(kind, data, i) >= 128)
2364 break;
2365 }
2366 invalid_char = i;
2367 goto error;
2368 }
2369
2370 assert(PyUnicode_KIND(string) == PyUnicode_1BYTE_KIND);
2371 str = PyUnicode_1BYTE_DATA(string);
2372
2373 /* This overestimates if there are spaces */
2374 buf = _PyBytesWriter_Alloc(&writer, hexlen / 2);
2375 if (buf == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002376 return NULL;
Victor Stinner2bf89932015-10-14 11:25:33 +02002377
2378 end = str + hexlen;
2379 while (str < end) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002380 /* skip over spaces in the input */
Victor Stinner2bf89932015-10-14 11:25:33 +02002381 if (*str == ' ') {
2382 do {
2383 str++;
2384 } while (*str == ' ');
2385 if (str >= end)
2386 break;
2387 }
2388
2389 top = _PyLong_DigitValue[*str];
2390 if (top >= 16) {
2391 invalid_char = str - PyUnicode_1BYTE_DATA(string);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002392 goto error;
2393 }
Victor Stinner2bf89932015-10-14 11:25:33 +02002394 str++;
2395
2396 bot = _PyLong_DigitValue[*str];
2397 if (bot >= 16) {
2398 invalid_char = str - PyUnicode_1BYTE_DATA(string);
2399 goto error;
2400 }
2401 str++;
2402
2403 *buf++ = (unsigned char)((top << 4) + bot);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 }
Victor Stinner2bf89932015-10-14 11:25:33 +02002405
2406 return _PyBytesWriter_Finish(&writer, buf);
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002407
2408 error:
Victor Stinner2bf89932015-10-14 11:25:33 +02002409 PyErr_Format(PyExc_ValueError,
2410 "non-hexadecimal number found in "
2411 "fromhex() arg at position %zd", invalid_char);
2412 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002413 return NULL;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002414}
2415
Gregory P. Smith8cb65692015-04-25 23:22:26 +00002416PyDoc_STRVAR(hex__doc__,
2417"B.hex() -> string\n\
2418\n\
2419Create a string of hexadecimal numbers from a bytes object.\n\
2420Example: b'\\xb9\\x01\\xef'.hex() -> 'b901ef'.");
2421
2422static PyObject *
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002423bytes_hex(PyBytesObject *self)
2424{
2425 char* argbuf = PyBytes_AS_STRING(self);
2426 Py_ssize_t arglen = PyBytes_GET_SIZE(self);
2427 return _Py_strhex(argbuf, arglen);
2428}
2429
2430static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002431bytes_getnewargs(PyBytesObject *v)
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002432{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002433 return Py_BuildValue("(y#)", v->ob_sval, Py_SIZE(v));
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002434}
2435
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002436
2437static PyMethodDef
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002438bytes_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002439 {"__getnewargs__", (PyCFunction)bytes_getnewargs, METH_NOARGS},
2440 {"capitalize", (PyCFunction)stringlib_capitalize, METH_NOARGS,
2441 _Py_capitalize__doc__},
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002442 {"center", (PyCFunction)stringlib_center, METH_VARARGS,
2443 _Py_center__doc__},
2444 {"count", (PyCFunction)bytes_count, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002445 _Py_count__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002446 BYTES_DECODE_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002447 {"endswith", (PyCFunction)bytes_endswith, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002448 _Py_endswith__doc__},
Ezio Melotti745d54d2013-11-16 19:10:57 +02002449 {"expandtabs", (PyCFunction)stringlib_expandtabs, METH_VARARGS | METH_KEYWORDS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002450 _Py_expandtabs__doc__},
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002451 {"find", (PyCFunction)bytes_find, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002452 _Py_find__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002453 BYTES_FROMHEX_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002454 {"hex", (PyCFunction)bytes_hex, METH_NOARGS, hex__doc__},
2455 {"index", (PyCFunction)bytes_index, METH_VARARGS, _Py_index__doc__},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002456 {"isalnum", (PyCFunction)stringlib_isalnum, METH_NOARGS,
2457 _Py_isalnum__doc__},
2458 {"isalpha", (PyCFunction)stringlib_isalpha, METH_NOARGS,
2459 _Py_isalpha__doc__},
2460 {"isdigit", (PyCFunction)stringlib_isdigit, METH_NOARGS,
2461 _Py_isdigit__doc__},
2462 {"islower", (PyCFunction)stringlib_islower, METH_NOARGS,
2463 _Py_islower__doc__},
2464 {"isspace", (PyCFunction)stringlib_isspace, METH_NOARGS,
2465 _Py_isspace__doc__},
2466 {"istitle", (PyCFunction)stringlib_istitle, METH_NOARGS,
2467 _Py_istitle__doc__},
2468 {"isupper", (PyCFunction)stringlib_isupper, METH_NOARGS,
2469 _Py_isupper__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002470 BYTES_JOIN_METHODDEF
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002471 {"ljust", (PyCFunction)stringlib_ljust, METH_VARARGS, _Py_ljust__doc__},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002472 {"lower", (PyCFunction)stringlib_lower, METH_NOARGS, _Py_lower__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002473 BYTES_LSTRIP_METHODDEF
2474 BYTES_MAKETRANS_METHODDEF
2475 BYTES_PARTITION_METHODDEF
2476 BYTES_REPLACE_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002477 {"rfind", (PyCFunction)bytes_rfind, METH_VARARGS, _Py_rfind__doc__},
2478 {"rindex", (PyCFunction)bytes_rindex, METH_VARARGS, _Py_rindex__doc__},
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002479 {"rjust", (PyCFunction)stringlib_rjust, METH_VARARGS, _Py_rjust__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002480 BYTES_RPARTITION_METHODDEF
2481 BYTES_RSPLIT_METHODDEF
2482 BYTES_RSTRIP_METHODDEF
2483 BYTES_SPLIT_METHODDEF
2484 BYTES_SPLITLINES_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002485 {"startswith", (PyCFunction)bytes_startswith, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002486 _Py_startswith__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002487 BYTES_STRIP_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002488 {"swapcase", (PyCFunction)stringlib_swapcase, METH_NOARGS,
2489 _Py_swapcase__doc__},
2490 {"title", (PyCFunction)stringlib_title, METH_NOARGS, _Py_title__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002491 BYTES_TRANSLATE_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002492 {"upper", (PyCFunction)stringlib_upper, METH_NOARGS, _Py_upper__doc__},
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002493 {"zfill", (PyCFunction)stringlib_zfill, METH_VARARGS, _Py_zfill__doc__},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002494 {NULL, NULL} /* sentinel */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002495};
2496
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002497static PyObject *
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002498bytes_mod(PyObject *self, PyObject *arg)
Ethan Furmanb95b5612015-01-23 20:05:18 -08002499{
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002500 if (!PyBytes_Check(self)) {
2501 Py_RETURN_NOTIMPLEMENTED;
Victor Stinner772b2b02015-10-14 09:56:53 +02002502 }
Victor Stinner772b2b02015-10-14 09:56:53 +02002503 return _PyBytes_FormatEx(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002504 arg, 0);
Ethan Furmanb95b5612015-01-23 20:05:18 -08002505}
2506
2507static PyNumberMethods bytes_as_number = {
2508 0, /*nb_add*/
2509 0, /*nb_subtract*/
2510 0, /*nb_multiply*/
2511 bytes_mod, /*nb_remainder*/
2512};
2513
2514static PyObject *
Serhiy Storchaka15095802015-11-25 15:47:01 +02002515bytes_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002516
2517static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002518bytes_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002519{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002520 PyObject *x = NULL;
2521 const char *encoding = NULL;
2522 const char *errors = NULL;
2523 PyObject *new = NULL;
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002524 PyObject *func;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002525 Py_ssize_t size;
2526 static char *kwlist[] = {"source", "encoding", "errors", 0};
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002527 _Py_IDENTIFIER(__bytes__);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002528
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002529 if (type != &PyBytes_Type)
Serhiy Storchaka15095802015-11-25 15:47:01 +02002530 return bytes_subtype_new(type, args, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002531 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytes", kwlist, &x,
2532 &encoding, &errors))
2533 return NULL;
2534 if (x == NULL) {
2535 if (encoding != NULL || errors != NULL) {
2536 PyErr_SetString(PyExc_TypeError,
2537 "encoding or errors without sequence "
2538 "argument");
2539 return NULL;
2540 }
Victor Stinnerdb067af2014-05-02 22:31:14 +02002541 return PyBytes_FromStringAndSize(NULL, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002542 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002543
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002544 if (encoding != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002545 /* Encode via the codec registry */
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002546 if (!PyUnicode_Check(x)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002547 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002548 "encoding without a string argument");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002549 return NULL;
2550 }
2551 new = PyUnicode_AsEncodedString(x, encoding, errors);
2552 if (new == NULL)
2553 return NULL;
2554 assert(PyBytes_Check(new));
2555 return new;
2556 }
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002557
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002558 if (errors != NULL) {
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +02002559 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002560 PyUnicode_Check(x) ?
2561 "string argument without an encoding" :
2562 "errors without a string argument");
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +02002563 return NULL;
2564 }
2565
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002566 /* We'd like to call PyObject_Bytes here, but we need to check for an
2567 integer argument before deferring to PyBytes_FromObject, something
2568 PyObject_Bytes doesn't do. */
2569 func = _PyObject_LookupSpecial(x, &PyId___bytes__);
2570 if (func != NULL) {
Victor Stinner27580c12016-12-01 14:43:22 +01002571 new = _PyObject_CallNoArg(func);
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002572 Py_DECREF(func);
2573 if (new == NULL)
2574 return NULL;
2575 if (!PyBytes_Check(new)) {
2576 PyErr_Format(PyExc_TypeError,
2577 "__bytes__ returned non-bytes (type %.200s)",
2578 Py_TYPE(new)->tp_name);
2579 Py_DECREF(new);
2580 return NULL;
2581 }
2582 return new;
2583 }
2584 else if (PyErr_Occurred())
2585 return NULL;
2586
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002587 if (PyUnicode_Check(x)) {
2588 PyErr_SetString(PyExc_TypeError,
2589 "string argument without an encoding");
2590 return NULL;
2591 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002592 /* Is it an integer? */
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002593 if (PyIndex_Check(x)) {
2594 size = PyNumber_AsSsize_t(x, PyExc_OverflowError);
2595 if (size == -1 && PyErr_Occurred()) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002596 return NULL;
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002597 }
2598 if (size < 0) {
2599 PyErr_SetString(PyExc_ValueError, "negative count");
2600 return NULL;
2601 }
Victor Stinnerdb067af2014-05-02 22:31:14 +02002602 new = _PyBytes_FromSize(size, 1);
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002603 if (new == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002604 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 return new;
2606 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002607
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002608 return PyBytes_FromObject(x);
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002609}
2610
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002611static PyObject*
2612_PyBytes_FromBuffer(PyObject *x)
2613{
2614 PyObject *new;
2615 Py_buffer view;
2616
2617 if (PyObject_GetBuffer(x, &view, PyBUF_FULL_RO) < 0)
2618 return NULL;
2619
2620 new = PyBytes_FromStringAndSize(NULL, view.len);
2621 if (!new)
2622 goto fail;
2623 if (PyBuffer_ToContiguous(((PyBytesObject *)new)->ob_sval,
2624 &view, view.len, 'C') < 0)
2625 goto fail;
2626 PyBuffer_Release(&view);
2627 return new;
2628
2629fail:
2630 Py_XDECREF(new);
2631 PyBuffer_Release(&view);
2632 return NULL;
2633}
2634
Victor Stinner3c50ce32015-10-14 13:50:40 +02002635#define _PyBytes_FROM_LIST_BODY(x, GET_ITEM) \
2636 do { \
2637 PyObject *bytes; \
2638 Py_ssize_t i; \
2639 Py_ssize_t value; \
2640 char *str; \
2641 PyObject *item; \
2642 \
2643 bytes = PyBytes_FromStringAndSize(NULL, Py_SIZE(x)); \
2644 if (bytes == NULL) \
2645 return NULL; \
2646 str = ((PyBytesObject *)bytes)->ob_sval; \
2647 \
2648 for (i = 0; i < Py_SIZE(x); i++) { \
2649 item = GET_ITEM((x), i); \
Serhiy Storchakaf54d7812016-07-06 21:39:44 +03002650 value = PyNumber_AsSsize_t(item, NULL); \
Victor Stinner3c50ce32015-10-14 13:50:40 +02002651 if (value == -1 && PyErr_Occurred()) \
2652 goto error; \
2653 \
2654 if (value < 0 || value >= 256) { \
2655 PyErr_SetString(PyExc_ValueError, \
2656 "bytes must be in range(0, 256)"); \
2657 goto error; \
2658 } \
2659 *str++ = (char) value; \
2660 } \
2661 return bytes; \
2662 \
2663 error: \
2664 Py_DECREF(bytes); \
2665 return NULL; \
2666 } while (0)
2667
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002668static PyObject*
2669_PyBytes_FromList(PyObject *x)
2670{
Victor Stinner3c50ce32015-10-14 13:50:40 +02002671 _PyBytes_FROM_LIST_BODY(x, PyList_GET_ITEM);
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002672}
2673
2674static PyObject*
2675_PyBytes_FromTuple(PyObject *x)
2676{
Victor Stinner3c50ce32015-10-14 13:50:40 +02002677 _PyBytes_FROM_LIST_BODY(x, PyTuple_GET_ITEM);
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002678}
2679
2680static PyObject *
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002681_PyBytes_FromIterator(PyObject *it, PyObject *x)
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002682{
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002683 char *str;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002684 Py_ssize_t i, size;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002685 _PyBytesWriter writer;
2686
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002687 /* For iterator version, create a string object and resize as needed */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02002688 size = PyObject_LengthHint(x, 64);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002689 if (size == -1 && PyErr_Occurred())
2690 return NULL;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002691
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002692 _PyBytesWriter_Init(&writer);
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002693 str = _PyBytesWriter_Alloc(&writer, size);
2694 if (str == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002695 return NULL;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002696 writer.overallocate = 1;
2697 size = writer.allocated;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002698
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002699 /* Run the iterator to exhaustion */
2700 for (i = 0; ; i++) {
2701 PyObject *item;
2702 Py_ssize_t value;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002703
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002704 /* Get the next item */
2705 item = PyIter_Next(it);
2706 if (item == NULL) {
2707 if (PyErr_Occurred())
2708 goto error;
2709 break;
2710 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002711
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002712 /* Interpret it as an int (__index__) */
Serhiy Storchakaf54d7812016-07-06 21:39:44 +03002713 value = PyNumber_AsSsize_t(item, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002714 Py_DECREF(item);
2715 if (value == -1 && PyErr_Occurred())
2716 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002717
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002718 /* Range check */
2719 if (value < 0 || value >= 256) {
2720 PyErr_SetString(PyExc_ValueError,
2721 "bytes must be in range(0, 256)");
2722 goto error;
2723 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002724
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002725 /* Append the byte */
2726 if (i >= size) {
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002727 str = _PyBytesWriter_Resize(&writer, str, size+1);
2728 if (str == NULL)
2729 return NULL;
2730 size = writer.allocated;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002731 }
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002732 *str++ = (char) value;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 }
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002734
2735 return _PyBytesWriter_Finish(&writer, str);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002736
2737 error:
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002738 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002739 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002740}
2741
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002742PyObject *
2743PyBytes_FromObject(PyObject *x)
2744{
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002745 PyObject *it, *result;
2746
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002747 if (x == NULL) {
2748 PyErr_BadInternalCall();
2749 return NULL;
2750 }
2751
2752 if (PyBytes_CheckExact(x)) {
2753 Py_INCREF(x);
2754 return x;
2755 }
2756
2757 /* Use the modern buffer interface */
2758 if (PyObject_CheckBuffer(x))
2759 return _PyBytes_FromBuffer(x);
2760
2761 if (PyList_CheckExact(x))
2762 return _PyBytes_FromList(x);
2763
2764 if (PyTuple_CheckExact(x))
2765 return _PyBytes_FromTuple(x);
2766
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002767 if (!PyUnicode_Check(x)) {
2768 it = PyObject_GetIter(x);
2769 if (it != NULL) {
2770 result = _PyBytes_FromIterator(it, x);
2771 Py_DECREF(it);
2772 return result;
2773 }
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002774 }
2775
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002776 PyErr_Format(PyExc_TypeError,
2777 "cannot convert '%.200s' object to bytes",
2778 x->ob_type->tp_name);
2779 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002780}
2781
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002782static PyObject *
Serhiy Storchaka15095802015-11-25 15:47:01 +02002783bytes_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002784{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002785 PyObject *tmp, *pnew;
2786 Py_ssize_t n;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002787
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 assert(PyType_IsSubtype(type, &PyBytes_Type));
2789 tmp = bytes_new(&PyBytes_Type, args, kwds);
2790 if (tmp == NULL)
2791 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02002792 assert(PyBytes_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002793 n = PyBytes_GET_SIZE(tmp);
2794 pnew = type->tp_alloc(type, n);
2795 if (pnew != NULL) {
Christian Heimesf051e432016-09-13 20:22:02 +02002796 memcpy(PyBytes_AS_STRING(pnew),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002797 PyBytes_AS_STRING(tmp), n+1);
2798 ((PyBytesObject *)pnew)->ob_shash =
2799 ((PyBytesObject *)tmp)->ob_shash;
2800 }
2801 Py_DECREF(tmp);
2802 return pnew;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002803}
2804
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002805PyDoc_STRVAR(bytes_doc,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002806"bytes(iterable_of_ints) -> bytes\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002807bytes(string, encoding[, errors]) -> bytes\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00002808bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer\n\
Victor Stinnerbb2e9c42011-12-17 23:18:07 +01002809bytes(int) -> bytes object of size given by the parameter initialized with null bytes\n\
2810bytes() -> empty bytes object\n\
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002811\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002812Construct an immutable array of bytes from:\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002813 - an iterable yielding integers in range(256)\n\
2814 - a text string encoded using the specified encoding\n\
Victor Stinnerbb2e9c42011-12-17 23:18:07 +01002815 - any object implementing the buffer API.\n\
2816 - an integer");
Guido van Rossum98297ee2007-11-06 21:34:58 +00002817
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002818static PyObject *bytes_iter(PyObject *seq);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002819
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002820PyTypeObject PyBytes_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002821 PyVarObject_HEAD_INIT(&PyType_Type, 0)
2822 "bytes",
2823 PyBytesObject_SIZE,
2824 sizeof(char),
2825 bytes_dealloc, /* tp_dealloc */
2826 0, /* tp_print */
2827 0, /* tp_getattr */
2828 0, /* tp_setattr */
2829 0, /* tp_reserved */
2830 (reprfunc)bytes_repr, /* tp_repr */
Ethan Furmanb95b5612015-01-23 20:05:18 -08002831 &bytes_as_number, /* tp_as_number */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002832 &bytes_as_sequence, /* tp_as_sequence */
2833 &bytes_as_mapping, /* tp_as_mapping */
2834 (hashfunc)bytes_hash, /* tp_hash */
2835 0, /* tp_call */
2836 bytes_str, /* tp_str */
2837 PyObject_GenericGetAttr, /* tp_getattro */
2838 0, /* tp_setattro */
2839 &bytes_as_buffer, /* tp_as_buffer */
2840 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
2841 Py_TPFLAGS_BYTES_SUBCLASS, /* tp_flags */
2842 bytes_doc, /* tp_doc */
2843 0, /* tp_traverse */
2844 0, /* tp_clear */
2845 (richcmpfunc)bytes_richcompare, /* tp_richcompare */
2846 0, /* tp_weaklistoffset */
2847 bytes_iter, /* tp_iter */
2848 0, /* tp_iternext */
2849 bytes_methods, /* tp_methods */
2850 0, /* tp_members */
2851 0, /* tp_getset */
2852 &PyBaseObject_Type, /* tp_base */
2853 0, /* tp_dict */
2854 0, /* tp_descr_get */
2855 0, /* tp_descr_set */
2856 0, /* tp_dictoffset */
2857 0, /* tp_init */
2858 0, /* tp_alloc */
2859 bytes_new, /* tp_new */
2860 PyObject_Del, /* tp_free */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002861};
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002862
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002863void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002864PyBytes_Concat(PyObject **pv, PyObject *w)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002865{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002866 assert(pv != NULL);
2867 if (*pv == NULL)
2868 return;
2869 if (w == NULL) {
Serhiy Storchakaf458a032013-02-02 18:45:22 +02002870 Py_CLEAR(*pv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002871 return;
2872 }
Antoine Pitrou161d6952014-05-01 14:36:20 +02002873
2874 if (Py_REFCNT(*pv) == 1 && PyBytes_CheckExact(*pv)) {
2875 /* Only one reference, so we can resize in place */
Zachary Warebca96942014-05-06 11:42:37 -05002876 Py_ssize_t oldsize;
Antoine Pitrou161d6952014-05-01 14:36:20 +02002877 Py_buffer wb;
Victor Stinner049e5092014-08-17 22:20:00 +02002878
Antoine Pitrou161d6952014-05-01 14:36:20 +02002879 wb.len = -1;
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002880 if (PyObject_GetBuffer(w, &wb, PyBUF_SIMPLE) != 0) {
Antoine Pitrou161d6952014-05-01 14:36:20 +02002881 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
2882 Py_TYPE(w)->tp_name, Py_TYPE(*pv)->tp_name);
2883 Py_CLEAR(*pv);
2884 return;
2885 }
2886
2887 oldsize = PyBytes_GET_SIZE(*pv);
2888 if (oldsize > PY_SSIZE_T_MAX - wb.len) {
2889 PyErr_NoMemory();
2890 goto error;
2891 }
2892 if (_PyBytes_Resize(pv, oldsize + wb.len) < 0)
2893 goto error;
2894
2895 memcpy(PyBytes_AS_STRING(*pv) + oldsize, wb.buf, wb.len);
2896 PyBuffer_Release(&wb);
2897 return;
2898
2899 error:
2900 PyBuffer_Release(&wb);
2901 Py_CLEAR(*pv);
2902 return;
2903 }
2904
2905 else {
2906 /* Multiple references, need to create new object */
2907 PyObject *v;
2908 v = bytes_concat(*pv, w);
Serhiy Storchaka57a01d32016-04-10 18:05:40 +03002909 Py_SETREF(*pv, v);
Antoine Pitrou161d6952014-05-01 14:36:20 +02002910 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002911}
2912
2913void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002914PyBytes_ConcatAndDel(PyObject **pv, PyObject *w)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002915{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002916 PyBytes_Concat(pv, w);
2917 Py_XDECREF(w);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002918}
2919
2920
Ethan Furmanb95b5612015-01-23 20:05:18 -08002921/* The following function breaks the notion that bytes are immutable:
2922 it changes the size of a bytes object. We get away with this only if there
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002923 is only one module referencing the object. You can also think of it
Ethan Furmanb95b5612015-01-23 20:05:18 -08002924 as creating a new bytes object and destroying the old one, only
2925 more efficiently. In any case, don't use this if the bytes object may
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002926 already be known to some other part of the code...
Ethan Furmanb95b5612015-01-23 20:05:18 -08002927 Note that if there's not enough memory to resize the bytes object, the
2928 original bytes object at *pv is deallocated, *pv is set to NULL, an "out of
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002929 memory" exception is set, and -1 is returned. Else (on success) 0 is
2930 returned, and the value in *pv may or may not be the same as on input.
2931 As always, an extra byte is allocated for a trailing \0 byte (newsize
2932 does *not* include that), and a trailing \0 byte is stored.
2933*/
2934
2935int
2936_PyBytes_Resize(PyObject **pv, Py_ssize_t newsize)
2937{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002938 PyObject *v;
2939 PyBytesObject *sv;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002940 v = *pv;
Berker Peksag4a72a7b2016-09-16 17:31:06 +03002941 if (!PyBytes_Check(v) || newsize < 0) {
2942 goto error;
2943 }
2944 if (Py_SIZE(v) == newsize) {
2945 /* return early if newsize equals to v->ob_size */
2946 return 0;
2947 }
2948 if (Py_REFCNT(v) != 1) {
2949 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002950 }
2951 /* XXX UNREF/NEWREF interface should be more symmetrical */
2952 _Py_DEC_REFTOTAL;
2953 _Py_ForgetReference(v);
2954 *pv = (PyObject *)
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03002955 PyObject_REALLOC(v, PyBytesObject_SIZE + newsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002956 if (*pv == NULL) {
2957 PyObject_Del(v);
2958 PyErr_NoMemory();
2959 return -1;
2960 }
2961 _Py_NewReference(*pv);
2962 sv = (PyBytesObject *) *pv;
2963 Py_SIZE(sv) = newsize;
2964 sv->ob_sval[newsize] = '\0';
2965 sv->ob_shash = -1; /* invalidate cached hash value */
2966 return 0;
Berker Peksag4a72a7b2016-09-16 17:31:06 +03002967error:
2968 *pv = 0;
2969 Py_DECREF(v);
2970 PyErr_BadInternalCall();
2971 return -1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002972}
2973
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002974void
2975PyBytes_Fini(void)
2976{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002977 int i;
Serhiy Storchakaf458a032013-02-02 18:45:22 +02002978 for (i = 0; i < UCHAR_MAX + 1; i++)
2979 Py_CLEAR(characters[i]);
2980 Py_CLEAR(nullstring);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002981}
2982
Benjamin Peterson4116f362008-05-27 00:36:20 +00002983/*********************** Bytes Iterator ****************************/
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002984
2985typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002986 PyObject_HEAD
2987 Py_ssize_t it_index;
2988 PyBytesObject *it_seq; /* Set to NULL when iterator is exhausted */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002989} striterobject;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002990
2991static void
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002992striter_dealloc(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002993{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 _PyObject_GC_UNTRACK(it);
2995 Py_XDECREF(it->it_seq);
2996 PyObject_GC_Del(it);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002997}
2998
2999static int
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003000striter_traverse(striterobject *it, visitproc visit, void *arg)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003001{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003002 Py_VISIT(it->it_seq);
3003 return 0;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003004}
3005
3006static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003007striter_next(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003008{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003009 PyBytesObject *seq;
3010 PyObject *item;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003011
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 assert(it != NULL);
3013 seq = it->it_seq;
3014 if (seq == NULL)
3015 return NULL;
3016 assert(PyBytes_Check(seq));
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003017
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 if (it->it_index < PyBytes_GET_SIZE(seq)) {
3019 item = PyLong_FromLong(
3020 (unsigned char)seq->ob_sval[it->it_index]);
3021 if (item != NULL)
3022 ++it->it_index;
3023 return item;
3024 }
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003025
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003026 it->it_seq = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +03003027 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003028 return NULL;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003029}
3030
3031static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003032striter_len(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003033{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003034 Py_ssize_t len = 0;
3035 if (it->it_seq)
3036 len = PyBytes_GET_SIZE(it->it_seq) - it->it_index;
3037 return PyLong_FromSsize_t(len);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003038}
3039
3040PyDoc_STRVAR(length_hint_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003041 "Private method returning an estimate of len(list(it)).");
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003042
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003043static PyObject *
3044striter_reduce(striterobject *it)
3045{
3046 if (it->it_seq != NULL) {
Antoine Pitroua7013882012-04-05 00:04:20 +02003047 return Py_BuildValue("N(O)n", _PyObject_GetBuiltin("iter"),
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003048 it->it_seq, it->it_index);
3049 } else {
Serhiy Storchaka460bd0d2016-11-20 12:16:46 +02003050 return Py_BuildValue("N(())", _PyObject_GetBuiltin("iter"));
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003051 }
3052}
3053
3054PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
3055
3056static PyObject *
3057striter_setstate(striterobject *it, PyObject *state)
3058{
3059 Py_ssize_t index = PyLong_AsSsize_t(state);
3060 if (index == -1 && PyErr_Occurred())
3061 return NULL;
Kristján Valur Jónsson25dded02014-03-05 13:47:57 +00003062 if (it->it_seq != NULL) {
3063 if (index < 0)
3064 index = 0;
3065 else if (index > PyBytes_GET_SIZE(it->it_seq))
3066 index = PyBytes_GET_SIZE(it->it_seq); /* iterator exhausted */
3067 it->it_index = index;
3068 }
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003069 Py_RETURN_NONE;
3070}
3071
3072PyDoc_STRVAR(setstate_doc, "Set state information for unpickling.");
3073
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003074static PyMethodDef striter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003075 {"__length_hint__", (PyCFunction)striter_len, METH_NOARGS,
3076 length_hint_doc},
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003077 {"__reduce__", (PyCFunction)striter_reduce, METH_NOARGS,
3078 reduce_doc},
3079 {"__setstate__", (PyCFunction)striter_setstate, METH_O,
3080 setstate_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003081 {NULL, NULL} /* sentinel */
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003082};
3083
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003084PyTypeObject PyBytesIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003085 PyVarObject_HEAD_INIT(&PyType_Type, 0)
3086 "bytes_iterator", /* tp_name */
3087 sizeof(striterobject), /* tp_basicsize */
3088 0, /* tp_itemsize */
3089 /* methods */
3090 (destructor)striter_dealloc, /* tp_dealloc */
3091 0, /* tp_print */
3092 0, /* tp_getattr */
3093 0, /* tp_setattr */
3094 0, /* tp_reserved */
3095 0, /* tp_repr */
3096 0, /* tp_as_number */
3097 0, /* tp_as_sequence */
3098 0, /* tp_as_mapping */
3099 0, /* tp_hash */
3100 0, /* tp_call */
3101 0, /* tp_str */
3102 PyObject_GenericGetAttr, /* tp_getattro */
3103 0, /* tp_setattro */
3104 0, /* tp_as_buffer */
3105 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
3106 0, /* tp_doc */
3107 (traverseproc)striter_traverse, /* tp_traverse */
3108 0, /* tp_clear */
3109 0, /* tp_richcompare */
3110 0, /* tp_weaklistoffset */
3111 PyObject_SelfIter, /* tp_iter */
3112 (iternextfunc)striter_next, /* tp_iternext */
3113 striter_methods, /* tp_methods */
3114 0,
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003115};
3116
3117static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003118bytes_iter(PyObject *seq)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003119{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003120 striterobject *it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003121
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003122 if (!PyBytes_Check(seq)) {
3123 PyErr_BadInternalCall();
3124 return NULL;
3125 }
3126 it = PyObject_GC_New(striterobject, &PyBytesIter_Type);
3127 if (it == NULL)
3128 return NULL;
3129 it->it_index = 0;
3130 Py_INCREF(seq);
3131 it->it_seq = (PyBytesObject *)seq;
3132 _PyObject_GC_TRACK(it);
3133 return (PyObject *)it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003134}
Victor Stinner00165072015-10-09 01:53:21 +02003135
3136
3137/* _PyBytesWriter API */
3138
3139#ifdef MS_WINDOWS
3140 /* On Windows, overallocate by 50% is the best factor */
3141# define OVERALLOCATE_FACTOR 2
3142#else
3143 /* On Linux, overallocate by 25% is the best factor */
3144# define OVERALLOCATE_FACTOR 4
3145#endif
3146
3147void
3148_PyBytesWriter_Init(_PyBytesWriter *writer)
3149{
Victor Stinner661aacc2015-10-14 09:41:48 +02003150 /* Set all attributes before small_buffer to 0 */
3151 memset(writer, 0, offsetof(_PyBytesWriter, small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003152#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003153 memset(writer->small_buffer, 0xCB, sizeof(writer->small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003154#endif
3155}
3156
3157void
3158_PyBytesWriter_Dealloc(_PyBytesWriter *writer)
3159{
3160 Py_CLEAR(writer->buffer);
3161}
3162
3163Py_LOCAL_INLINE(char*)
3164_PyBytesWriter_AsString(_PyBytesWriter *writer)
3165{
Victor Stinner661aacc2015-10-14 09:41:48 +02003166 if (writer->use_small_buffer) {
Victor Stinner00165072015-10-09 01:53:21 +02003167 assert(writer->buffer == NULL);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003168 return writer->small_buffer;
Victor Stinner00165072015-10-09 01:53:21 +02003169 }
Victor Stinner661aacc2015-10-14 09:41:48 +02003170 else if (writer->use_bytearray) {
3171 assert(writer->buffer != NULL);
3172 return PyByteArray_AS_STRING(writer->buffer);
3173 }
3174 else {
3175 assert(writer->buffer != NULL);
3176 return PyBytes_AS_STRING(writer->buffer);
3177 }
Victor Stinner00165072015-10-09 01:53:21 +02003178}
3179
3180Py_LOCAL_INLINE(Py_ssize_t)
Victor Stinner2bf89932015-10-14 11:25:33 +02003181_PyBytesWriter_GetSize(_PyBytesWriter *writer, char *str)
Victor Stinner00165072015-10-09 01:53:21 +02003182{
3183 char *start = _PyBytesWriter_AsString(writer);
3184 assert(str != NULL);
3185 assert(str >= start);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003186 assert(str - start <= writer->allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003187 return str - start;
3188}
3189
3190Py_LOCAL_INLINE(void)
3191_PyBytesWriter_CheckConsistency(_PyBytesWriter *writer, char *str)
3192{
3193#ifdef Py_DEBUG
3194 char *start, *end;
3195
Victor Stinner661aacc2015-10-14 09:41:48 +02003196 if (writer->use_small_buffer) {
Victor Stinner00165072015-10-09 01:53:21 +02003197 assert(writer->buffer == NULL);
3198 }
Victor Stinner661aacc2015-10-14 09:41:48 +02003199 else {
3200 assert(writer->buffer != NULL);
3201 if (writer->use_bytearray)
3202 assert(PyByteArray_CheckExact(writer->buffer));
3203 else
3204 assert(PyBytes_CheckExact(writer->buffer));
3205 assert(Py_REFCNT(writer->buffer) == 1);
3206 }
Victor Stinner00165072015-10-09 01:53:21 +02003207
Victor Stinner661aacc2015-10-14 09:41:48 +02003208 if (writer->use_bytearray) {
3209 /* bytearray has its own overallocation algorithm,
3210 writer overallocation must be disabled */
3211 assert(!writer->overallocate);
3212 }
3213
3214 assert(0 <= writer->allocated);
Victor Stinner53926a12015-10-09 12:37:03 +02003215 assert(0 <= writer->min_size && writer->min_size <= writer->allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003216 /* the last byte must always be null */
Victor Stinner661aacc2015-10-14 09:41:48 +02003217 start = _PyBytesWriter_AsString(writer);
Victor Stinner00165072015-10-09 01:53:21 +02003218 assert(start[writer->allocated] == 0);
3219
3220 end = start + writer->allocated;
3221 assert(str != NULL);
3222 assert(start <= str && str <= end);
3223#endif
3224}
3225
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003226void*
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003227_PyBytesWriter_Resize(_PyBytesWriter *writer, void *str, Py_ssize_t size)
Victor Stinner00165072015-10-09 01:53:21 +02003228{
3229 Py_ssize_t allocated, pos;
3230
3231 _PyBytesWriter_CheckConsistency(writer, str);
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003232 assert(writer->allocated < size);
Victor Stinner00165072015-10-09 01:53:21 +02003233
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003234 allocated = size;
Victor Stinner00165072015-10-09 01:53:21 +02003235 if (writer->overallocate
3236 && allocated <= (PY_SSIZE_T_MAX - allocated / OVERALLOCATE_FACTOR)) {
3237 /* overallocate to limit the number of realloc() */
3238 allocated += allocated / OVERALLOCATE_FACTOR;
3239 }
3240
Victor Stinner2bf89932015-10-14 11:25:33 +02003241 pos = _PyBytesWriter_GetSize(writer, str);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003242 if (!writer->use_small_buffer) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003243 if (writer->use_bytearray) {
3244 if (PyByteArray_Resize(writer->buffer, allocated))
3245 goto error;
3246 /* writer->allocated can be smaller than writer->buffer->ob_alloc,
3247 but we cannot use ob_alloc because bytes may need to be moved
3248 to use the whole buffer. bytearray uses an internal optimization
3249 to avoid moving or copying bytes when bytes are removed at the
3250 beginning (ex: del bytearray[:1]). */
3251 }
3252 else {
3253 if (_PyBytes_Resize(&writer->buffer, allocated))
3254 goto error;
Victor Stinner00165072015-10-09 01:53:21 +02003255 }
3256 }
3257 else {
3258 /* convert from stack buffer to bytes object buffer */
3259 assert(writer->buffer == NULL);
3260
Victor Stinner661aacc2015-10-14 09:41:48 +02003261 if (writer->use_bytearray)
3262 writer->buffer = PyByteArray_FromStringAndSize(NULL, allocated);
3263 else
3264 writer->buffer = PyBytes_FromStringAndSize(NULL, allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003265 if (writer->buffer == NULL)
Victor Stinner661aacc2015-10-14 09:41:48 +02003266 goto error;
Victor Stinner00165072015-10-09 01:53:21 +02003267
3268 if (pos != 0) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003269 char *dest;
3270 if (writer->use_bytearray)
3271 dest = PyByteArray_AS_STRING(writer->buffer);
3272 else
3273 dest = PyBytes_AS_STRING(writer->buffer);
Christian Heimesf051e432016-09-13 20:22:02 +02003274 memcpy(dest,
Victor Stinnerb3653a32015-10-09 03:38:24 +02003275 writer->small_buffer,
Victor Stinner00165072015-10-09 01:53:21 +02003276 pos);
3277 }
3278
Victor Stinnerb3653a32015-10-09 03:38:24 +02003279 writer->use_small_buffer = 0;
Victor Stinner00165072015-10-09 01:53:21 +02003280#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003281 memset(writer->small_buffer, 0xDB, sizeof(writer->small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003282#endif
Victor Stinner00165072015-10-09 01:53:21 +02003283 }
3284 writer->allocated = allocated;
3285
3286 str = _PyBytesWriter_AsString(writer) + pos;
3287 _PyBytesWriter_CheckConsistency(writer, str);
3288 return str;
Victor Stinner661aacc2015-10-14 09:41:48 +02003289
3290error:
3291 _PyBytesWriter_Dealloc(writer);
3292 return NULL;
Victor Stinner00165072015-10-09 01:53:21 +02003293}
3294
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003295void*
3296_PyBytesWriter_Prepare(_PyBytesWriter *writer, void *str, Py_ssize_t size)
3297{
3298 Py_ssize_t new_min_size;
3299
3300 _PyBytesWriter_CheckConsistency(writer, str);
3301 assert(size >= 0);
3302
3303 if (size == 0) {
3304 /* nothing to do */
3305 return str;
3306 }
3307
3308 if (writer->min_size > PY_SSIZE_T_MAX - size) {
3309 PyErr_NoMemory();
3310 _PyBytesWriter_Dealloc(writer);
3311 return NULL;
3312 }
3313 new_min_size = writer->min_size + size;
3314
3315 if (new_min_size > writer->allocated)
3316 str = _PyBytesWriter_Resize(writer, str, new_min_size);
3317
3318 writer->min_size = new_min_size;
3319 return str;
3320}
3321
Victor Stinner00165072015-10-09 01:53:21 +02003322/* Allocate the buffer to write size bytes.
3323 Return the pointer to the beginning of buffer data.
3324 Raise an exception and return NULL on error. */
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003325void*
Victor Stinner00165072015-10-09 01:53:21 +02003326_PyBytesWriter_Alloc(_PyBytesWriter *writer, Py_ssize_t size)
3327{
3328 /* ensure that _PyBytesWriter_Alloc() is only called once */
Victor Stinner53926a12015-10-09 12:37:03 +02003329 assert(writer->min_size == 0 && writer->buffer == NULL);
Victor Stinner00165072015-10-09 01:53:21 +02003330 assert(size >= 0);
3331
Victor Stinnerb3653a32015-10-09 03:38:24 +02003332 writer->use_small_buffer = 1;
Victor Stinnerb13b97d2015-10-09 02:52:16 +02003333#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003334 writer->allocated = sizeof(writer->small_buffer) - 1;
Victor Stinnerf6358a72015-10-14 12:02:39 +02003335 /* In debug mode, don't use the full small buffer because it is less
3336 efficient than bytes and bytearray objects to detect buffer underflow
3337 and buffer overflow. Use 10 bytes of the small buffer to test also
3338 code using the smaller buffer in debug mode.
3339
3340 Don't modify the _PyBytesWriter structure (use a shorter small buffer)
3341 in debug mode to also be able to detect stack overflow when running
3342 tests in debug mode. The _PyBytesWriter is large (more than 512 bytes),
3343 if Py_EnterRecursiveCall() is not used in deep C callback, we may hit a
3344 stack overflow. */
3345 writer->allocated = Py_MIN(writer->allocated, 10);
3346 /* _PyBytesWriter_CheckConsistency() requires the last byte to be 0,
3347 to detect buffer overflow */
Victor Stinnerb3653a32015-10-09 03:38:24 +02003348 writer->small_buffer[writer->allocated] = 0;
Victor Stinner00165072015-10-09 01:53:21 +02003349#else
Victor Stinnerb3653a32015-10-09 03:38:24 +02003350 writer->allocated = sizeof(writer->small_buffer);
Victor Stinner00165072015-10-09 01:53:21 +02003351#endif
Victor Stinnerb3653a32015-10-09 03:38:24 +02003352 return _PyBytesWriter_Prepare(writer, writer->small_buffer, size);
Victor Stinner00165072015-10-09 01:53:21 +02003353}
3354
3355PyObject *
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003356_PyBytesWriter_Finish(_PyBytesWriter *writer, void *str)
Victor Stinner00165072015-10-09 01:53:21 +02003357{
Victor Stinner2bf89932015-10-14 11:25:33 +02003358 Py_ssize_t size;
Victor Stinner00165072015-10-09 01:53:21 +02003359 PyObject *result;
3360
3361 _PyBytesWriter_CheckConsistency(writer, str);
3362
Victor Stinner2bf89932015-10-14 11:25:33 +02003363 size = _PyBytesWriter_GetSize(writer, str);
3364 if (size == 0 && !writer->use_bytearray) {
Victor Stinner6c2cdae2015-10-12 13:29:43 +02003365 Py_CLEAR(writer->buffer);
3366 /* Get the empty byte string singleton */
3367 result = PyBytes_FromStringAndSize(NULL, 0);
3368 }
3369 else if (writer->use_small_buffer) {
Victor Stinnere914d412016-04-15 17:52:27 +02003370 if (writer->use_bytearray) {
3371 result = PyByteArray_FromStringAndSize(writer->small_buffer, size);
3372 }
3373 else {
3374 result = PyBytes_FromStringAndSize(writer->small_buffer, size);
3375 }
Victor Stinner6c2cdae2015-10-12 13:29:43 +02003376 }
3377 else {
3378 result = writer->buffer;
3379 writer->buffer = NULL;
3380
Victor Stinner2bf89932015-10-14 11:25:33 +02003381 if (size != writer->allocated) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003382 if (writer->use_bytearray) {
Victor Stinner2bf89932015-10-14 11:25:33 +02003383 if (PyByteArray_Resize(result, size)) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003384 Py_DECREF(result);
3385 return NULL;
3386 }
3387 }
3388 else {
Victor Stinner2bf89932015-10-14 11:25:33 +02003389 if (_PyBytes_Resize(&result, size)) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003390 assert(result == NULL);
3391 return NULL;
3392 }
Victor Stinner00165072015-10-09 01:53:21 +02003393 }
3394 }
Victor Stinner00165072015-10-09 01:53:21 +02003395 }
Victor Stinner00165072015-10-09 01:53:21 +02003396 return result;
3397}
Victor Stinnerce179bf2015-10-09 12:57:22 +02003398
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003399void*
Victor Stinnere9aa5952015-10-12 13:57:47 +02003400_PyBytesWriter_WriteBytes(_PyBytesWriter *writer, void *ptr,
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003401 const void *bytes, Py_ssize_t size)
Victor Stinnerce179bf2015-10-09 12:57:22 +02003402{
Victor Stinnere9aa5952015-10-12 13:57:47 +02003403 char *str = (char *)ptr;
3404
Victor Stinnerce179bf2015-10-09 12:57:22 +02003405 str = _PyBytesWriter_Prepare(writer, str, size);
3406 if (str == NULL)
3407 return NULL;
3408
Christian Heimesf051e432016-09-13 20:22:02 +02003409 memcpy(str, bytes, size);
Victor Stinnerce179bf2015-10-09 12:57:22 +02003410 str += size;
3411
3412 return str;
3413}