blob: b7c5b75283ee2774f9d1ebb75a1c356bfbcc1a3e [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"
Victor Stinnerbcda8f12018-11-21 22:27:47 +01006#include "pycore_object.h"
Victor Stinner621cebe2018-11-12 16:53:38 +01007#include "pycore_pymem.h"
8#include "pycore_pystate.h"
Christian Heimes2c9c7a52008-05-26 13:42:13 +00009
Gregory P. Smith60d241f2007-10-16 06:31:30 +000010#include "bytes_methods.h"
Gregory P. Smith8cb65692015-04-25 23:22:26 +000011#include "pystrhex.h"
Mark Dickinsonfd24b322008-12-06 15:33:31 +000012#include <stddef.h>
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000013
Martin v. Löwis7252a6e2014-07-27 16:25:09 +020014/*[clinic input]
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +030015class bytes "PyBytesObject *" "&PyBytes_Type"
Martin v. Löwis7252a6e2014-07-27 16:25:09 +020016[clinic start generated code]*/
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +030017/*[clinic end generated code: output=da39a3ee5e6b4b0d input=7a238f965d64892b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +020018
Serhiy Storchaka1009bf12015-04-03 23:53:51 +030019#include "clinic/bytesobject.c.h"
20
Christian Heimes2c9c7a52008-05-26 13:42:13 +000021#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +000022Py_ssize_t _Py_null_strings, _Py_one_strings;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000023#endif
Guido van Rossum4dfe8a12006-04-22 23:28:04 +000024
Christian Heimes2c9c7a52008-05-26 13:42:13 +000025static PyBytesObject *characters[UCHAR_MAX + 1];
26static PyBytesObject *nullstring;
27
Mark Dickinsonfd24b322008-12-06 15:33:31 +000028/* PyBytesObject_SIZE gives the basic size of a string; any memory allocation
29 for a string of length n should request PyBytesObject_SIZE + n bytes.
30
31 Using PyBytesObject_SIZE instead of sizeof(PyBytesObject) saves
32 3 bytes per string allocation on a typical system.
33*/
34#define PyBytesObject_SIZE (offsetof(PyBytesObject, ob_sval) + 1)
35
Victor Stinner2bf89932015-10-14 11:25:33 +020036/* Forward declaration */
37Py_LOCAL_INLINE(Py_ssize_t) _PyBytesWriter_GetSize(_PyBytesWriter *writer,
38 char *str);
39
Christian Heimes2c9c7a52008-05-26 13:42:13 +000040/*
Christian Heimes2c9c7a52008-05-26 13:42:13 +000041 For PyBytes_FromString(), the parameter `str' points to a null-terminated
42 string containing exactly `size' bytes.
43
Martin Pantera90a4a92016-05-30 04:04:50 +000044 For PyBytes_FromStringAndSize(), the parameter `str' is
Christian Heimes2c9c7a52008-05-26 13:42:13 +000045 either NULL or else points to a string containing at least `size' bytes.
46 For PyBytes_FromStringAndSize(), the string in the `str' parameter does
47 not have to be null-terminated. (Therefore it is safe to construct a
48 substring by calling `PyBytes_FromStringAndSize(origstring, substrlen)'.)
49 If `str' is NULL then PyBytes_FromStringAndSize() will allocate `size+1'
50 bytes (setting the last byte to the null terminating character) and you can
51 fill in the data yourself. If `str' is non-NULL then the resulting
Antoine Pitrouf2c54842010-01-13 08:07:53 +000052 PyBytes object must be treated as immutable and you must not fill in nor
Christian Heimes2c9c7a52008-05-26 13:42:13 +000053 alter the data yourself, since the strings may be shared.
54
55 The PyObject member `op->ob_size', which denotes the number of "extra
56 items" in a variable-size object, will contain the number of bytes
Eli Bendersky1aef6b62011-03-24 22:32:56 +020057 allocated for string data, not counting the null terminating character.
58 It is therefore equal to the `size' parameter (for
Christian Heimes2c9c7a52008-05-26 13:42:13 +000059 PyBytes_FromStringAndSize()) or the length of the string in the `str'
60 parameter (for PyBytes_FromString()).
61*/
Victor Stinnerdb067af2014-05-02 22:31:14 +020062static PyObject *
63_PyBytes_FromSize(Py_ssize_t size, int use_calloc)
Guido van Rossumd624f182006-04-24 13:47:05 +000064{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +020065 PyBytesObject *op;
Victor Stinnerdb067af2014-05-02 22:31:14 +020066 assert(size >= 0);
Victor Stinner049e5092014-08-17 22:20:00 +020067
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000068 if (size == 0 && (op = nullstring) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +000069#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +000070 _Py_null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +000071#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000072 Py_INCREF(op);
73 return (PyObject *)op;
74 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +000075
Victor Stinner049e5092014-08-17 22:20:00 +020076 if ((size_t)size > (size_t)PY_SSIZE_T_MAX - PyBytesObject_SIZE) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000077 PyErr_SetString(PyExc_OverflowError,
78 "byte string is too large");
79 return NULL;
80 }
Neal Norwitz3ce5d922008-08-24 07:08:55 +000081
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000082 /* Inline PyObject_NewVar */
Victor Stinnerdb067af2014-05-02 22:31:14 +020083 if (use_calloc)
84 op = (PyBytesObject *)PyObject_Calloc(1, PyBytesObject_SIZE + size);
85 else
86 op = (PyBytesObject *)PyObject_Malloc(PyBytesObject_SIZE + size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000087 if (op == NULL)
88 return PyErr_NoMemory();
Victor Stinnerb509d522018-11-23 14:27:38 +010089 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000090 op->ob_shash = -1;
Victor Stinnerdb067af2014-05-02 22:31:14 +020091 if (!use_calloc)
92 op->ob_sval[size] = '\0';
93 /* empty byte string singleton */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +000094 if (size == 0) {
95 nullstring = op;
96 Py_INCREF(op);
Victor Stinnerdb067af2014-05-02 22:31:14 +020097 }
98 return (PyObject *) op;
99}
100
101PyObject *
102PyBytes_FromStringAndSize(const char *str, Py_ssize_t size)
103{
104 PyBytesObject *op;
105 if (size < 0) {
106 PyErr_SetString(PyExc_SystemError,
107 "Negative size passed to PyBytes_FromStringAndSize");
108 return NULL;
109 }
110 if (size == 1 && str != NULL &&
111 (op = characters[*str & UCHAR_MAX]) != NULL)
112 {
113#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +0000114 _Py_one_strings++;
Victor Stinnerdb067af2014-05-02 22:31:14 +0200115#endif
116 Py_INCREF(op);
117 return (PyObject *)op;
118 }
119
120 op = (PyBytesObject *)_PyBytes_FromSize(size, 0);
121 if (op == NULL)
122 return NULL;
123 if (str == NULL)
124 return (PyObject *) op;
125
Christian Heimesf051e432016-09-13 20:22:02 +0200126 memcpy(op->ob_sval, str, size);
Victor Stinnerdb067af2014-05-02 22:31:14 +0200127 /* share short strings */
128 if (size == 1) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000129 characters[*str & UCHAR_MAX] = op;
130 Py_INCREF(op);
131 }
132 return (PyObject *) op;
Guido van Rossumd624f182006-04-24 13:47:05 +0000133}
134
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000135PyObject *
136PyBytes_FromString(const char *str)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000137{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +0200138 size_t size;
139 PyBytesObject *op;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000140
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000141 assert(str != NULL);
142 size = strlen(str);
143 if (size > PY_SSIZE_T_MAX - PyBytesObject_SIZE) {
144 PyErr_SetString(PyExc_OverflowError,
145 "byte string is too long");
146 return NULL;
147 }
148 if (size == 0 && (op = nullstring) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000149#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +0000150 _Py_null_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000151#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000152 Py_INCREF(op);
153 return (PyObject *)op;
154 }
155 if (size == 1 && (op = characters[*str & UCHAR_MAX]) != NULL) {
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000156#ifdef COUNT_ALLOCS
Pablo Galindo49c75a82018-10-28 15:02:17 +0000157 _Py_one_strings++;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000158#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000159 Py_INCREF(op);
160 return (PyObject *)op;
161 }
Guido van Rossum98297ee2007-11-06 21:34:58 +0000162
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000163 /* Inline PyObject_NewVar */
164 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + size);
165 if (op == NULL)
166 return PyErr_NoMemory();
Victor Stinnerb509d522018-11-23 14:27:38 +0100167 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000168 op->ob_shash = -1;
Christian Heimesf051e432016-09-13 20:22:02 +0200169 memcpy(op->ob_sval, str, size+1);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000170 /* share short strings */
171 if (size == 0) {
172 nullstring = op;
173 Py_INCREF(op);
174 } else if (size == 1) {
175 characters[*str & UCHAR_MAX] = op;
176 Py_INCREF(op);
177 }
178 return (PyObject *) op;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000179}
Guido van Rossumebea9be2007-04-09 00:49:13 +0000180
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000181PyObject *
182PyBytes_FromFormatV(const char *format, va_list vargs)
183{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000184 char *s;
Victor Stinner03dab782015-10-14 00:21:35 +0200185 const char *f;
186 const char *p;
187 Py_ssize_t prec;
188 int longflag;
189 int size_tflag;
190 /* Longest 64-bit formatted numbers:
191 - "18446744073709551615\0" (21 bytes)
192 - "-9223372036854775808\0" (21 bytes)
193 Decimal takes the most space (it isn't enough for octal.)
Guido van Rossum343e97f2007-04-09 00:43:24 +0000194
Victor Stinner03dab782015-10-14 00:21:35 +0200195 Longest 64-bit pointer representation:
196 "0xffffffffffffffff\0" (19 bytes). */
197 char buffer[21];
198 _PyBytesWriter writer;
Guido van Rossum343e97f2007-04-09 00:43:24 +0000199
Victor Stinner03dab782015-10-14 00:21:35 +0200200 _PyBytesWriter_Init(&writer);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000201
Victor Stinner03dab782015-10-14 00:21:35 +0200202 s = _PyBytesWriter_Alloc(&writer, strlen(format));
203 if (s == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000204 return NULL;
Victor Stinner03dab782015-10-14 00:21:35 +0200205 writer.overallocate = 1;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000206
Victor Stinner03dab782015-10-14 00:21:35 +0200207#define WRITE_BYTES(str) \
208 do { \
209 s = _PyBytesWriter_WriteBytes(&writer, s, (str), strlen(str)); \
210 if (s == NULL) \
211 goto error; \
212 } while (0)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000213
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000214 for (f = format; *f; f++) {
Victor Stinner03dab782015-10-14 00:21:35 +0200215 if (*f != '%') {
216 *s++ = *f;
217 continue;
218 }
219
220 p = f++;
221
222 /* ignore the width (ex: 10 in "%10s") */
223 while (Py_ISDIGIT(*f))
224 f++;
225
226 /* parse the precision (ex: 10 in "%.10s") */
227 prec = 0;
228 if (*f == '.') {
229 f++;
230 for (; Py_ISDIGIT(*f); f++) {
231 prec = (prec * 10) + (*f - '0');
232 }
233 }
234
235 while (*f && *f != '%' && !Py_ISALPHA(*f))
236 f++;
237
238 /* handle the long flag ('l'), but only for %ld and %lu.
239 others can be added when necessary. */
240 longflag = 0;
241 if (*f == 'l' && (f[1] == 'd' || f[1] == 'u')) {
242 longflag = 1;
243 ++f;
244 }
245
246 /* handle the size_t flag ('z'). */
247 size_tflag = 0;
248 if (*f == 'z' && (f[1] == 'd' || f[1] == 'u')) {
249 size_tflag = 1;
250 ++f;
251 }
252
Raymond Hettinger15f44ab2016-08-30 10:47:49 -0700253 /* subtract bytes preallocated for the format string
Victor Stinner03dab782015-10-14 00:21:35 +0200254 (ex: 2 for "%s") */
255 writer.min_size -= (f - p + 1);
256
257 switch (*f) {
258 case 'c':
259 {
260 int c = va_arg(vargs, int);
261 if (c < 0 || c > 255) {
262 PyErr_SetString(PyExc_OverflowError,
263 "PyBytes_FromFormatV(): %c format "
264 "expects an integer in range [0; 255]");
265 goto error;
266 }
267 writer.min_size++;
268 *s++ = (unsigned char)c;
269 break;
270 }
271
272 case 'd':
273 if (longflag)
274 sprintf(buffer, "%ld", va_arg(vargs, long));
275 else if (size_tflag)
276 sprintf(buffer, "%" PY_FORMAT_SIZE_T "d",
277 va_arg(vargs, Py_ssize_t));
278 else
279 sprintf(buffer, "%d", va_arg(vargs, int));
280 assert(strlen(buffer) < sizeof(buffer));
281 WRITE_BYTES(buffer);
282 break;
283
284 case 'u':
285 if (longflag)
286 sprintf(buffer, "%lu",
287 va_arg(vargs, unsigned long));
288 else if (size_tflag)
289 sprintf(buffer, "%" PY_FORMAT_SIZE_T "u",
290 va_arg(vargs, size_t));
291 else
292 sprintf(buffer, "%u",
293 va_arg(vargs, unsigned int));
294 assert(strlen(buffer) < sizeof(buffer));
295 WRITE_BYTES(buffer);
296 break;
297
298 case 'i':
299 sprintf(buffer, "%i", va_arg(vargs, int));
300 assert(strlen(buffer) < sizeof(buffer));
301 WRITE_BYTES(buffer);
302 break;
303
304 case 'x':
305 sprintf(buffer, "%x", va_arg(vargs, int));
306 assert(strlen(buffer) < sizeof(buffer));
307 WRITE_BYTES(buffer);
308 break;
309
310 case 's':
311 {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000312 Py_ssize_t i;
Victor Stinner03dab782015-10-14 00:21:35 +0200313
Serhiy Storchakaef1585e2015-12-25 20:01:53 +0200314 p = va_arg(vargs, const char*);
Serhiy Storchakad586ccb2019-01-12 10:30:35 +0200315 if (prec <= 0) {
316 i = strlen(p);
317 }
318 else {
319 i = 0;
320 while (i < prec && p[i]) {
321 i++;
322 }
323 }
Victor Stinner03dab782015-10-14 00:21:35 +0200324 s = _PyBytesWriter_WriteBytes(&writer, s, p, i);
325 if (s == NULL)
326 goto error;
327 break;
328 }
329
330 case 'p':
331 sprintf(buffer, "%p", va_arg(vargs, void*));
332 assert(strlen(buffer) < sizeof(buffer));
333 /* %p is ill-defined: ensure leading 0x. */
334 if (buffer[1] == 'X')
335 buffer[1] = 'x';
336 else if (buffer[1] != 'x') {
337 memmove(buffer+2, buffer, strlen(buffer)+1);
338 buffer[0] = '0';
339 buffer[1] = 'x';
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000340 }
Victor Stinner03dab782015-10-14 00:21:35 +0200341 WRITE_BYTES(buffer);
342 break;
343
344 case '%':
345 writer.min_size++;
346 *s++ = '%';
347 break;
348
349 default:
350 if (*f == 0) {
351 /* fix min_size if we reached the end of the format string */
352 writer.min_size++;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000353 }
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000354
Victor Stinner03dab782015-10-14 00:21:35 +0200355 /* invalid format string: copy unformatted string and exit */
356 WRITE_BYTES(p);
357 return _PyBytesWriter_Finish(&writer, s);
358 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000359 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000360
Victor Stinner03dab782015-10-14 00:21:35 +0200361#undef WRITE_BYTES
362
363 return _PyBytesWriter_Finish(&writer, s);
364
365 error:
366 _PyBytesWriter_Dealloc(&writer);
367 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000368}
369
370PyObject *
371PyBytes_FromFormat(const char *format, ...)
372{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000373 PyObject* ret;
374 va_list vargs;
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000375
376#ifdef HAVE_STDARG_PROTOTYPES
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000377 va_start(vargs, format);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000378#else
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000379 va_start(vargs);
Christian Heimes2c9c7a52008-05-26 13:42:13 +0000380#endif
Antoine Pitrouf95a1b32010-05-09 15:52:27 +0000381 ret = PyBytes_FromFormatV(format, vargs);
382 va_end(vargs);
383 return ret;
Guido van Rossum4dfe8a12006-04-22 23:28:04 +0000384}
385
Ethan Furmanb95b5612015-01-23 20:05:18 -0800386/* Helpers for formatstring */
387
388Py_LOCAL_INLINE(PyObject *)
389getnextarg(PyObject *args, Py_ssize_t arglen, Py_ssize_t *p_argidx)
390{
391 Py_ssize_t argidx = *p_argidx;
392 if (argidx < arglen) {
393 (*p_argidx)++;
394 if (arglen < 0)
395 return args;
396 else
397 return PyTuple_GetItem(args, argidx);
398 }
399 PyErr_SetString(PyExc_TypeError,
400 "not enough arguments for format string");
401 return NULL;
402}
403
404/* Format codes
405 * F_LJUST '-'
406 * F_SIGN '+'
407 * F_BLANK ' '
408 * F_ALT '#'
409 * F_ZERO '0'
410 */
411#define F_LJUST (1<<0)
412#define F_SIGN (1<<1)
413#define F_BLANK (1<<2)
414#define F_ALT (1<<3)
415#define F_ZERO (1<<4)
416
417/* Returns a new reference to a PyBytes object, or NULL on failure. */
418
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200419static char*
420formatfloat(PyObject *v, int flags, int prec, int type,
Victor Stinnerad771582015-10-09 12:38:53 +0200421 PyObject **p_result, _PyBytesWriter *writer, char *str)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800422{
423 char *p;
424 PyObject *result;
425 double x;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200426 size_t len;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800427
428 x = PyFloat_AsDouble(v);
429 if (x == -1.0 && PyErr_Occurred()) {
430 PyErr_Format(PyExc_TypeError, "float argument required, "
431 "not %.200s", Py_TYPE(v)->tp_name);
432 return NULL;
433 }
434
435 if (prec < 0)
436 prec = 6;
437
438 p = PyOS_double_to_string(x, type, prec,
439 (flags & F_ALT) ? Py_DTSF_ALT : 0, NULL);
440
441 if (p == NULL)
442 return NULL;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200443
444 len = strlen(p);
445 if (writer != NULL) {
Victor Stinnerad771582015-10-09 12:38:53 +0200446 str = _PyBytesWriter_Prepare(writer, str, len);
447 if (str == NULL)
448 return NULL;
Christian Heimesf051e432016-09-13 20:22:02 +0200449 memcpy(str, p, len);
Victor Stinner71dc3d82016-04-26 12:35:13 +0200450 PyMem_Free(p);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200451 str += len;
452 return str;
453 }
454
455 result = PyBytes_FromStringAndSize(p, len);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800456 PyMem_Free(p);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200457 *p_result = result;
Zackery Spytz96c59322018-10-03 00:01:30 -0600458 return result != NULL ? str : NULL;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800459}
460
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300461static PyObject *
462formatlong(PyObject *v, int flags, int prec, int type)
463{
464 PyObject *result, *iobj;
465 if (type == 'i')
466 type = 'd';
467 if (PyLong_Check(v))
468 return _PyUnicode_FormatLong(v, flags & F_ALT, prec, type);
469 if (PyNumber_Check(v)) {
470 /* make sure number is a type of integer for o, x, and X */
471 if (type == 'o' || type == 'x' || type == 'X')
472 iobj = PyNumber_Index(v);
473 else
474 iobj = PyNumber_Long(v);
475 if (iobj == NULL) {
476 if (!PyErr_ExceptionMatches(PyExc_TypeError))
477 return NULL;
478 }
479 else if (!PyLong_Check(iobj))
480 Py_CLEAR(iobj);
481 if (iobj != NULL) {
482 result = _PyUnicode_FormatLong(iobj, flags & F_ALT, prec, type);
483 Py_DECREF(iobj);
484 return result;
485 }
486 }
487 PyErr_Format(PyExc_TypeError,
488 "%%%c format: %s is required, not %.200s", type,
489 (type == 'o' || type == 'x' || type == 'X') ? "an integer"
490 : "a number",
491 Py_TYPE(v)->tp_name);
492 return NULL;
493}
494
495static int
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200496byte_converter(PyObject *arg, char *p)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800497{
Serhiy Storchakadd40fc32016-05-04 22:23:26 +0300498 if (PyBytes_Check(arg) && PyBytes_GET_SIZE(arg) == 1) {
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200499 *p = PyBytes_AS_STRING(arg)[0];
500 return 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800501 }
Serhiy Storchakadd40fc32016-05-04 22:23:26 +0300502 else if (PyByteArray_Check(arg) && PyByteArray_GET_SIZE(arg) == 1) {
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200503 *p = PyByteArray_AS_STRING(arg)[0];
504 return 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800505 }
506 else {
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300507 PyObject *iobj;
508 long ival;
509 int overflow;
510 /* make sure number is a type of integer */
511 if (PyLong_Check(arg)) {
512 ival = PyLong_AsLongAndOverflow(arg, &overflow);
513 }
514 else {
515 iobj = PyNumber_Index(arg);
516 if (iobj == NULL) {
517 if (!PyErr_ExceptionMatches(PyExc_TypeError))
518 return 0;
519 goto onError;
520 }
521 ival = PyLong_AsLongAndOverflow(iobj, &overflow);
522 Py_DECREF(iobj);
523 }
Serhiy Storchaka41525e32015-04-03 20:53:46 +0300524 if (!overflow && ival == -1 && PyErr_Occurred())
525 goto onError;
526 if (overflow || !(0 <= ival && ival <= 255)) {
527 PyErr_SetString(PyExc_OverflowError,
528 "%c arg not in range(256)");
529 return 0;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800530 }
Serhiy Storchaka41525e32015-04-03 20:53:46 +0300531 *p = (char)ival;
532 return 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800533 }
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300534 onError:
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200535 PyErr_SetString(PyExc_TypeError,
536 "%c requires an integer in range(256) or a single byte");
537 return 0;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800538}
539
Xiang Zhang7e2a54c2017-03-14 15:07:15 +0800540static PyObject *_PyBytes_FromBuffer(PyObject *x);
541
Ethan Furmanb95b5612015-01-23 20:05:18 -0800542static PyObject *
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200543format_obj(PyObject *v, const char **pbuf, Py_ssize_t *plen)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800544{
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200545 PyObject *func, *result;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800546 _Py_IDENTIFIER(__bytes__);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800547 /* is it a bytes object? */
548 if (PyBytes_Check(v)) {
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200549 *pbuf = PyBytes_AS_STRING(v);
550 *plen = PyBytes_GET_SIZE(v);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800551 Py_INCREF(v);
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200552 return v;
553 }
554 if (PyByteArray_Check(v)) {
555 *pbuf = PyByteArray_AS_STRING(v);
556 *plen = PyByteArray_GET_SIZE(v);
557 Py_INCREF(v);
558 return v;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800559 }
560 /* does it support __bytes__? */
561 func = _PyObject_LookupSpecial(v, &PyId___bytes__);
562 if (func != NULL) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +0100563 result = _PyObject_CallNoArg(func);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800564 Py_DECREF(func);
565 if (result == NULL)
566 return NULL;
567 if (!PyBytes_Check(result)) {
568 PyErr_Format(PyExc_TypeError,
569 "__bytes__ returned non-bytes (type %.200s)",
570 Py_TYPE(result)->tp_name);
571 Py_DECREF(result);
572 return NULL;
573 }
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200574 *pbuf = PyBytes_AS_STRING(result);
575 *plen = PyBytes_GET_SIZE(result);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800576 return result;
577 }
Xiang Zhang7e2a54c2017-03-14 15:07:15 +0800578 /* does it support buffer protocol? */
579 if (PyObject_CheckBuffer(v)) {
580 /* maybe we can avoid making a copy of the buffer object here? */
581 result = _PyBytes_FromBuffer(v);
582 if (result == NULL)
583 return NULL;
584 *pbuf = PyBytes_AS_STRING(result);
585 *plen = PyBytes_GET_SIZE(result);
586 return result;
587 }
Ethan Furmanb95b5612015-01-23 20:05:18 -0800588 PyErr_Format(PyExc_TypeError,
Xiang Zhang7e2a54c2017-03-14 15:07:15 +0800589 "%%b requires a bytes-like object, "
590 "or an object that implements __bytes__, not '%.100s'",
Ethan Furmanb95b5612015-01-23 20:05:18 -0800591 Py_TYPE(v)->tp_name);
592 return NULL;
593}
594
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200595/* fmt%(v1,v2,...) is roughly equivalent to sprintf(fmt, v1, v2, ...) */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800596
597PyObject *
Victor Stinner772b2b02015-10-14 09:56:53 +0200598_PyBytes_FormatEx(const char *format, Py_ssize_t format_len,
599 PyObject *args, int use_bytearray)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800600{
Victor Stinner772b2b02015-10-14 09:56:53 +0200601 const char *fmt;
602 char *res;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800603 Py_ssize_t arglen, argidx;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200604 Py_ssize_t fmtcnt;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800605 int args_owned = 0;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800606 PyObject *dict = NULL;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200607 _PyBytesWriter writer;
608
Victor Stinner772b2b02015-10-14 09:56:53 +0200609 if (args == NULL) {
Ethan Furmanb95b5612015-01-23 20:05:18 -0800610 PyErr_BadInternalCall();
611 return NULL;
612 }
Victor Stinner772b2b02015-10-14 09:56:53 +0200613 fmt = format;
614 fmtcnt = format_len;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200615
616 _PyBytesWriter_Init(&writer);
Victor Stinner772b2b02015-10-14 09:56:53 +0200617 writer.use_bytearray = use_bytearray;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200618
619 res = _PyBytesWriter_Alloc(&writer, fmtcnt);
620 if (res == NULL)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800621 return NULL;
Victor Stinner772b2b02015-10-14 09:56:53 +0200622 if (!use_bytearray)
623 writer.overallocate = 1;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200624
Ethan Furmanb95b5612015-01-23 20:05:18 -0800625 if (PyTuple_Check(args)) {
626 arglen = PyTuple_GET_SIZE(args);
627 argidx = 0;
628 }
629 else {
630 arglen = -1;
631 argidx = -2;
632 }
633 if (Py_TYPE(args)->tp_as_mapping && Py_TYPE(args)->tp_as_mapping->mp_subscript &&
634 !PyTuple_Check(args) && !PyBytes_Check(args) && !PyUnicode_Check(args) &&
635 !PyByteArray_Check(args)) {
636 dict = args;
637 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200638
Ethan Furmanb95b5612015-01-23 20:05:18 -0800639 while (--fmtcnt >= 0) {
640 if (*fmt != '%') {
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200641 Py_ssize_t len;
642 char *pos;
643
Xiang Zhangb76ad512017-03-06 17:17:05 +0800644 pos = (char *)memchr(fmt + 1, '%', fmtcnt);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200645 if (pos != NULL)
646 len = pos - fmt;
Victor Stinner772b2b02015-10-14 09:56:53 +0200647 else
Xiang Zhangb76ad512017-03-06 17:17:05 +0800648 len = fmtcnt + 1;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200649 assert(len != 0);
650
Christian Heimesf051e432016-09-13 20:22:02 +0200651 memcpy(res, fmt, len);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200652 res += len;
653 fmt += len;
654 fmtcnt -= (len - 1);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800655 }
656 else {
657 /* Got a format specifier */
658 int flags = 0;
659 Py_ssize_t width = -1;
660 int prec = -1;
661 int c = '\0';
662 int fill;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800663 PyObject *v = NULL;
664 PyObject *temp = NULL;
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200665 const char *pbuf = NULL;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800666 int sign;
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200667 Py_ssize_t len = 0;
668 char onechar; /* For byte_converter() */
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200669 Py_ssize_t alloc;
670#ifdef Py_DEBUG
671 char *before;
672#endif
Ethan Furmanb95b5612015-01-23 20:05:18 -0800673
Ethan Furmanb95b5612015-01-23 20:05:18 -0800674 fmt++;
Serhiy Storchaka9f8ad3f2017-03-08 05:51:19 +0200675 if (*fmt == '%') {
676 *res++ = '%';
677 fmt++;
678 fmtcnt--;
679 continue;
680 }
Ethan Furmanb95b5612015-01-23 20:05:18 -0800681 if (*fmt == '(') {
Victor Stinner772b2b02015-10-14 09:56:53 +0200682 const char *keystart;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800683 Py_ssize_t keylen;
684 PyObject *key;
685 int pcount = 1;
686
687 if (dict == NULL) {
688 PyErr_SetString(PyExc_TypeError,
689 "format requires a mapping");
690 goto error;
691 }
692 ++fmt;
693 --fmtcnt;
694 keystart = fmt;
695 /* Skip over balanced parentheses */
696 while (pcount > 0 && --fmtcnt >= 0) {
697 if (*fmt == ')')
698 --pcount;
699 else if (*fmt == '(')
700 ++pcount;
701 fmt++;
702 }
703 keylen = fmt - keystart - 1;
704 if (fmtcnt < 0 || pcount > 0) {
705 PyErr_SetString(PyExc_ValueError,
706 "incomplete format key");
707 goto error;
708 }
709 key = PyBytes_FromStringAndSize(keystart,
710 keylen);
711 if (key == NULL)
712 goto error;
713 if (args_owned) {
714 Py_DECREF(args);
715 args_owned = 0;
716 }
717 args = PyObject_GetItem(dict, key);
718 Py_DECREF(key);
719 if (args == NULL) {
720 goto error;
721 }
722 args_owned = 1;
723 arglen = -1;
724 argidx = -2;
725 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200726
727 /* Parse flags. Example: "%+i" => flags=F_SIGN. */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800728 while (--fmtcnt >= 0) {
729 switch (c = *fmt++) {
730 case '-': flags |= F_LJUST; continue;
731 case '+': flags |= F_SIGN; continue;
732 case ' ': flags |= F_BLANK; continue;
733 case '#': flags |= F_ALT; continue;
734 case '0': flags |= F_ZERO; continue;
735 }
736 break;
737 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200738
739 /* Parse width. Example: "%10s" => width=10 */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800740 if (c == '*') {
741 v = getnextarg(args, arglen, &argidx);
742 if (v == NULL)
743 goto error;
744 if (!PyLong_Check(v)) {
745 PyErr_SetString(PyExc_TypeError,
746 "* wants int");
747 goto error;
748 }
749 width = PyLong_AsSsize_t(v);
750 if (width == -1 && PyErr_Occurred())
751 goto error;
752 if (width < 0) {
753 flags |= F_LJUST;
754 width = -width;
755 }
756 if (--fmtcnt >= 0)
757 c = *fmt++;
758 }
759 else if (c >= 0 && isdigit(c)) {
760 width = c - '0';
761 while (--fmtcnt >= 0) {
762 c = Py_CHARMASK(*fmt++);
763 if (!isdigit(c))
764 break;
765 if (width > (PY_SSIZE_T_MAX - ((int)c - '0')) / 10) {
766 PyErr_SetString(
767 PyExc_ValueError,
768 "width too big");
769 goto error;
770 }
771 width = width*10 + (c - '0');
772 }
773 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200774
775 /* Parse precision. Example: "%.3f" => prec=3 */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800776 if (c == '.') {
777 prec = 0;
778 if (--fmtcnt >= 0)
779 c = *fmt++;
780 if (c == '*') {
781 v = getnextarg(args, arglen, &argidx);
782 if (v == NULL)
783 goto error;
784 if (!PyLong_Check(v)) {
785 PyErr_SetString(
786 PyExc_TypeError,
787 "* wants int");
788 goto error;
789 }
Serhiy Storchaka26861b02015-02-16 20:52:17 +0200790 prec = _PyLong_AsInt(v);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800791 if (prec == -1 && PyErr_Occurred())
792 goto error;
793 if (prec < 0)
794 prec = 0;
795 if (--fmtcnt >= 0)
796 c = *fmt++;
797 }
798 else if (c >= 0 && isdigit(c)) {
799 prec = c - '0';
800 while (--fmtcnt >= 0) {
801 c = Py_CHARMASK(*fmt++);
802 if (!isdigit(c))
803 break;
804 if (prec > (INT_MAX - ((int)c - '0')) / 10) {
805 PyErr_SetString(
806 PyExc_ValueError,
807 "prec too big");
808 goto error;
809 }
810 prec = prec*10 + (c - '0');
811 }
812 }
813 } /* prec */
814 if (fmtcnt >= 0) {
815 if (c == 'h' || c == 'l' || c == 'L') {
816 if (--fmtcnt >= 0)
817 c = *fmt++;
818 }
819 }
820 if (fmtcnt < 0) {
821 PyErr_SetString(PyExc_ValueError,
822 "incomplete format");
823 goto error;
824 }
Serhiy Storchaka9f8ad3f2017-03-08 05:51:19 +0200825 v = getnextarg(args, arglen, &argidx);
826 if (v == NULL)
827 goto error;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200828
Alexey Izbyshevccd99752018-08-23 10:50:52 +0300829 if (fmtcnt == 0) {
830 /* last write: disable writer overallocation */
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200831 writer.overallocate = 0;
832 }
833
Ethan Furmanb95b5612015-01-23 20:05:18 -0800834 sign = 0;
835 fill = ' ';
836 switch (c) {
Ethan Furman62e977f2015-03-11 08:17:00 -0700837 case 'r':
838 // %r is only for 2/3 code; 3 only code should use %a
Ethan Furmanb95b5612015-01-23 20:05:18 -0800839 case 'a':
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200840 temp = PyObject_ASCII(v);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800841 if (temp == NULL)
842 goto error;
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200843 assert(PyUnicode_IS_ASCII(temp));
844 pbuf = (const char *)PyUnicode_1BYTE_DATA(temp);
845 len = PyUnicode_GET_LENGTH(temp);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800846 if (prec >= 0 && len > prec)
847 len = prec;
848 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200849
Ethan Furmanb95b5612015-01-23 20:05:18 -0800850 case 's':
851 // %s is only for 2/3 code; 3 only code should use %b
852 case 'b':
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200853 temp = format_obj(v, &pbuf, &len);
Ethan Furmanb95b5612015-01-23 20:05:18 -0800854 if (temp == NULL)
855 goto error;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800856 if (prec >= 0 && len > prec)
857 len = prec;
858 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200859
Ethan Furmanb95b5612015-01-23 20:05:18 -0800860 case 'i':
861 case 'd':
862 case 'u':
863 case 'o':
864 case 'x':
865 case 'X':
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200866 if (PyLong_CheckExact(v)
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200867 && width == -1 && prec == -1
868 && !(flags & (F_SIGN | F_BLANK))
869 && c != 'X')
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200870 {
871 /* Fast path */
872 int alternate = flags & F_ALT;
873 int base;
874
875 switch(c)
876 {
877 default:
Barry Warsawb2e57942017-09-14 18:13:16 -0700878 Py_UNREACHABLE();
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200879 case 'd':
880 case 'i':
881 case 'u':
882 base = 10;
883 break;
884 case 'o':
885 base = 8;
886 break;
887 case 'x':
888 case 'X':
889 base = 16;
890 break;
891 }
892
893 /* Fast path */
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200894 writer.min_size -= 2; /* size preallocated for "%d" */
Victor Stinnerbe75b8c2015-10-09 22:43:24 +0200895 res = _PyLong_FormatBytesWriter(&writer, res,
896 v, base, alternate);
897 if (res == NULL)
898 goto error;
899 continue;
900 }
901
Serhiy Storchaka2c7b5a92015-03-30 09:19:08 +0300902 temp = formatlong(v, flags, prec, c);
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200903 if (!temp)
904 goto error;
905 assert(PyUnicode_IS_ASCII(temp));
906 pbuf = (const char *)PyUnicode_1BYTE_DATA(temp);
907 len = PyUnicode_GET_LENGTH(temp);
908 sign = 1;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800909 if (flags & F_ZERO)
910 fill = '0';
911 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200912
Ethan Furmanb95b5612015-01-23 20:05:18 -0800913 case 'e':
914 case 'E':
915 case 'f':
916 case 'F':
917 case 'g':
918 case 'G':
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200919 if (width == -1 && prec == -1
920 && !(flags & (F_SIGN | F_BLANK)))
921 {
922 /* Fast path */
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200923 writer.min_size -= 2; /* size preallocated for "%f" */
Victor Stinnerad771582015-10-09 12:38:53 +0200924 res = formatfloat(v, flags, prec, c, NULL, &writer, res);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200925 if (res == NULL)
926 goto error;
927 continue;
928 }
929
Victor Stinnerad771582015-10-09 12:38:53 +0200930 if (!formatfloat(v, flags, prec, c, &temp, NULL, res))
Ethan Furmanb95b5612015-01-23 20:05:18 -0800931 goto error;
932 pbuf = PyBytes_AS_STRING(temp);
933 len = PyBytes_GET_SIZE(temp);
934 sign = 1;
935 if (flags & F_ZERO)
936 fill = '0';
937 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200938
Ethan Furmanb95b5612015-01-23 20:05:18 -0800939 case 'c':
Serhiy Storchakaea5ce5a2015-02-10 23:23:12 +0200940 pbuf = &onechar;
941 len = byte_converter(v, &onechar);
942 if (!len)
Ethan Furmanb95b5612015-01-23 20:05:18 -0800943 goto error;
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200944 if (width == -1) {
945 /* Fast path */
946 *res++ = onechar;
947 continue;
948 }
Ethan Furmanb95b5612015-01-23 20:05:18 -0800949 break;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200950
Ethan Furmanb95b5612015-01-23 20:05:18 -0800951 default:
952 PyErr_Format(PyExc_ValueError,
953 "unsupported format character '%c' (0x%x) "
954 "at index %zd",
955 c, c,
Victor Stinner772b2b02015-10-14 09:56:53 +0200956 (Py_ssize_t)(fmt - 1 - format));
Ethan Furmanb95b5612015-01-23 20:05:18 -0800957 goto error;
958 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200959
Ethan Furmanb95b5612015-01-23 20:05:18 -0800960 if (sign) {
961 if (*pbuf == '-' || *pbuf == '+') {
962 sign = *pbuf++;
963 len--;
964 }
965 else if (flags & F_SIGN)
966 sign = '+';
967 else if (flags & F_BLANK)
968 sign = ' ';
969 else
970 sign = 0;
971 }
972 if (width < len)
973 width = len;
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200974
975 alloc = width;
976 if (sign != 0 && len == width)
977 alloc++;
Victor Stinner0cdad1e2015-10-09 22:50:36 +0200978 /* 2: size preallocated for %s */
979 if (alloc > 2) {
980 res = _PyBytesWriter_Prepare(&writer, res, alloc - 2);
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200981 if (res == NULL)
982 goto error;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800983 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200984#ifdef Py_DEBUG
985 before = res;
986#endif
987
988 /* Write the sign if needed */
Ethan Furmanb95b5612015-01-23 20:05:18 -0800989 if (sign) {
990 if (fill != ' ')
991 *res++ = sign;
Ethan Furmanb95b5612015-01-23 20:05:18 -0800992 if (width > len)
993 width--;
994 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +0200995
996 /* Write the numeric prefix for "x", "X" and "o" formats
997 if the alternate form is used.
998 For example, write "0x" for the "%#x" format. */
Serhiy Storchakab1a16192016-12-17 21:48:03 +0200999 if ((flags & F_ALT) && (c == 'o' || c == 'x' || c == 'X')) {
Ethan Furmanb95b5612015-01-23 20:05:18 -08001000 assert(pbuf[0] == '0');
1001 assert(pbuf[1] == c);
1002 if (fill != ' ') {
1003 *res++ = *pbuf++;
1004 *res++ = *pbuf++;
1005 }
Ethan Furmanb95b5612015-01-23 20:05:18 -08001006 width -= 2;
1007 if (width < 0)
1008 width = 0;
1009 len -= 2;
1010 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001011
1012 /* Pad left with the fill character if needed */
Ethan Furmanb95b5612015-01-23 20:05:18 -08001013 if (width > len && !(flags & F_LJUST)) {
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001014 memset(res, fill, width - len);
1015 res += (width - len);
1016 width = len;
Ethan Furmanb95b5612015-01-23 20:05:18 -08001017 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001018
1019 /* If padding with spaces: write sign if needed and/or numeric
1020 prefix if the alternate form is used */
Ethan Furmanb95b5612015-01-23 20:05:18 -08001021 if (fill == ' ') {
1022 if (sign)
1023 *res++ = sign;
Serhiy Storchakab1a16192016-12-17 21:48:03 +02001024 if ((flags & F_ALT) && (c == 'o' || c == 'x' || c == 'X')) {
Ethan Furmanb95b5612015-01-23 20:05:18 -08001025 assert(pbuf[0] == '0');
1026 assert(pbuf[1] == c);
1027 *res++ = *pbuf++;
1028 *res++ = *pbuf++;
1029 }
1030 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001031
1032 /* Copy bytes */
Christian Heimesf051e432016-09-13 20:22:02 +02001033 memcpy(res, pbuf, len);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001034 res += len;
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001035
1036 /* Pad right with the fill character if needed */
1037 if (width > len) {
1038 memset(res, ' ', width - len);
1039 res += (width - len);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001040 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001041
Serhiy Storchaka9f8ad3f2017-03-08 05:51:19 +02001042 if (dict && (argidx < arglen)) {
Ethan Furmanb95b5612015-01-23 20:05:18 -08001043 PyErr_SetString(PyExc_TypeError,
1044 "not all arguments converted during bytes formatting");
Ethan Furmanb95b5612015-01-23 20:05:18 -08001045 Py_XDECREF(temp);
1046 goto error;
1047 }
Ethan Furmanb95b5612015-01-23 20:05:18 -08001048 Py_XDECREF(temp);
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001049
1050#ifdef Py_DEBUG
1051 /* check that we computed the exact size for this write */
1052 assert((res - before) == alloc);
1053#endif
Ethan Furmanb95b5612015-01-23 20:05:18 -08001054 } /* '%' */
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001055
1056 /* If overallocation was disabled, ensure that it was the last
1057 write. Otherwise, we missed an optimization */
Alexey Izbyshevccd99752018-08-23 10:50:52 +03001058 assert(writer.overallocate || fmtcnt == 0 || use_bytearray);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001059 } /* until end */
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001060
Ethan Furmanb95b5612015-01-23 20:05:18 -08001061 if (argidx < arglen && !dict) {
1062 PyErr_SetString(PyExc_TypeError,
1063 "not all arguments converted during bytes formatting");
1064 goto error;
1065 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001066
Ethan Furmanb95b5612015-01-23 20:05:18 -08001067 if (args_owned) {
1068 Py_DECREF(args);
1069 }
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001070 return _PyBytesWriter_Finish(&writer, res);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001071
1072 error:
Victor Stinnerfa7762e2015-10-09 11:48:06 +02001073 _PyBytesWriter_Dealloc(&writer);
Ethan Furmanb95b5612015-01-23 20:05:18 -08001074 if (args_owned) {
1075 Py_DECREF(args);
1076 }
1077 return NULL;
1078}
1079
1080/* =-= */
1081
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001082static void
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001083bytes_dealloc(PyObject *op)
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001084{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001085 Py_TYPE(op)->tp_free(op);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00001086}
1087
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001088/* Unescape a backslash-escaped string. If unicode is non-zero,
1089 the string is a u-literal. If recode_encoding is non-zero,
1090 the string is UTF-8 encoded and should be re-encoded in the
1091 specified encoding. */
1092
Victor Stinner2ec80632015-10-14 13:32:13 +02001093static char *
1094_PyBytes_DecodeEscapeRecode(const char **s, const char *end,
1095 const char *errors, const char *recode_encoding,
1096 _PyBytesWriter *writer, char *p)
1097{
1098 PyObject *u, *w;
1099 const char* t;
1100
1101 t = *s;
1102 /* Decode non-ASCII bytes as UTF-8. */
1103 while (t < end && (*t & 0x80))
1104 t++;
1105 u = PyUnicode_DecodeUTF8(*s, t - *s, errors);
1106 if (u == NULL)
1107 return NULL;
1108
1109 /* Recode them in target encoding. */
1110 w = PyUnicode_AsEncodedString(u, recode_encoding, errors);
1111 Py_DECREF(u);
1112 if (w == NULL)
1113 return NULL;
1114 assert(PyBytes_Check(w));
1115
1116 /* Append bytes to output buffer. */
Raymond Hettinger15f44ab2016-08-30 10:47:49 -07001117 writer->min_size--; /* subtract 1 preallocated byte */
Victor Stinner2ec80632015-10-14 13:32:13 +02001118 p = _PyBytesWriter_WriteBytes(writer, p,
1119 PyBytes_AS_STRING(w),
1120 PyBytes_GET_SIZE(w));
1121 Py_DECREF(w);
1122 if (p == NULL)
1123 return NULL;
1124
1125 *s = t;
1126 return p;
1127}
1128
Eric V. Smith42454af2016-10-31 09:22:08 -04001129PyObject *_PyBytes_DecodeEscape(const char *s,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001130 Py_ssize_t len,
1131 const char *errors,
1132 Py_ssize_t unicode,
Eric V. Smith42454af2016-10-31 09:22:08 -04001133 const char *recode_encoding,
1134 const char **first_invalid_escape)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001135{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001136 int c;
Victor Stinner2ec80632015-10-14 13:32:13 +02001137 char *p;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001138 const char *end;
Victor Stinner2ec80632015-10-14 13:32:13 +02001139 _PyBytesWriter writer;
1140
1141 _PyBytesWriter_Init(&writer);
1142
1143 p = _PyBytesWriter_Alloc(&writer, len);
1144 if (p == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001145 return NULL;
Victor Stinner2ec80632015-10-14 13:32:13 +02001146 writer.overallocate = 1;
1147
Eric V. Smith42454af2016-10-31 09:22:08 -04001148 *first_invalid_escape = NULL;
1149
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001150 end = s + len;
1151 while (s < end) {
1152 if (*s != '\\') {
1153 non_esc:
Victor Stinner2ec80632015-10-14 13:32:13 +02001154 if (!(recode_encoding && (*s & 0x80))) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001155 *p++ = *s++;
1156 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001157 else {
1158 /* non-ASCII character and need to recode */
1159 p = _PyBytes_DecodeEscapeRecode(&s, end,
1160 errors, recode_encoding,
1161 &writer, p);
1162 if (p == NULL)
1163 goto failed;
1164 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001165 continue;
1166 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001167
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001168 s++;
Victor Stinner2ec80632015-10-14 13:32:13 +02001169 if (s == end) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001170 PyErr_SetString(PyExc_ValueError,
1171 "Trailing \\ in string");
1172 goto failed;
1173 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001174
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001175 switch (*s++) {
1176 /* XXX This assumes ASCII! */
1177 case '\n': break;
1178 case '\\': *p++ = '\\'; break;
1179 case '\'': *p++ = '\''; break;
1180 case '\"': *p++ = '\"'; break;
1181 case 'b': *p++ = '\b'; break;
1182 case 'f': *p++ = '\014'; break; /* FF */
1183 case 't': *p++ = '\t'; break;
1184 case 'n': *p++ = '\n'; break;
1185 case 'r': *p++ = '\r'; break;
1186 case 'v': *p++ = '\013'; break; /* VT */
1187 case 'a': *p++ = '\007'; break; /* BEL, not classic C */
1188 case '0': case '1': case '2': case '3':
1189 case '4': case '5': case '6': case '7':
1190 c = s[-1] - '0';
1191 if (s < end && '0' <= *s && *s <= '7') {
1192 c = (c<<3) + *s++ - '0';
1193 if (s < end && '0' <= *s && *s <= '7')
1194 c = (c<<3) + *s++ - '0';
1195 }
1196 *p++ = c;
1197 break;
1198 case 'x':
Victor Stinner2ec80632015-10-14 13:32:13 +02001199 if (s+1 < end) {
1200 int digit1, digit2;
1201 digit1 = _PyLong_DigitValue[Py_CHARMASK(s[0])];
1202 digit2 = _PyLong_DigitValue[Py_CHARMASK(s[1])];
1203 if (digit1 < 16 && digit2 < 16) {
1204 *p++ = (unsigned char)((digit1 << 4) + digit2);
1205 s += 2;
1206 break;
1207 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001208 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001209 /* invalid hexadecimal digits */
1210
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001211 if (!errors || strcmp(errors, "strict") == 0) {
Serhiy Storchaka5e61f142013-02-10 17:36:00 +02001212 PyErr_Format(PyExc_ValueError,
Serhiy Storchakad53fe5f2019-03-13 22:59:55 +02001213 "invalid \\x escape at position %zd",
Serhiy Storchaka801d9552013-02-10 17:42:01 +02001214 s - 2 - (end - len));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001215 goto failed;
1216 }
1217 if (strcmp(errors, "replace") == 0) {
1218 *p++ = '?';
1219 } else if (strcmp(errors, "ignore") == 0)
1220 /* do nothing */;
1221 else {
1222 PyErr_Format(PyExc_ValueError,
1223 "decoding error; unknown "
1224 "error handling code: %.400s",
1225 errors);
1226 goto failed;
1227 }
Serhiy Storchakaace3ad32013-01-25 23:31:43 +02001228 /* skip \x */
1229 if (s < end && Py_ISXDIGIT(s[0]))
1230 s++; /* and a hexdigit */
1231 break;
Victor Stinner2ec80632015-10-14 13:32:13 +02001232
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001233 default:
Eric V. Smith42454af2016-10-31 09:22:08 -04001234 if (*first_invalid_escape == NULL) {
1235 *first_invalid_escape = s-1; /* Back up one char, since we've
1236 already incremented s. */
1237 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001238 *p++ = '\\';
Eric V. Smith42454af2016-10-31 09:22:08 -04001239 s--;
Ezio Melotti42da6632011-03-15 05:18:48 +02001240 goto non_esc; /* an arbitrary number of unescaped
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001241 UTF-8 bytes may follow. */
1242 }
1243 }
Victor Stinner2ec80632015-10-14 13:32:13 +02001244
1245 return _PyBytesWriter_Finish(&writer, p);
1246
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001247 failed:
Victor Stinner2ec80632015-10-14 13:32:13 +02001248 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001249 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001250}
1251
Eric V. Smith42454af2016-10-31 09:22:08 -04001252PyObject *PyBytes_DecodeEscape(const char *s,
1253 Py_ssize_t len,
1254 const char *errors,
1255 Py_ssize_t unicode,
1256 const char *recode_encoding)
1257{
1258 const char* first_invalid_escape;
1259 PyObject *result = _PyBytes_DecodeEscape(s, len, errors, unicode,
1260 recode_encoding,
1261 &first_invalid_escape);
1262 if (result == NULL)
1263 return NULL;
1264 if (first_invalid_escape != NULL) {
1265 if (PyErr_WarnFormat(PyExc_DeprecationWarning, 1,
1266 "invalid escape sequence '\\%c'",
Serhiy Storchaka56cb4652017-10-20 17:08:15 +03001267 (unsigned char)*first_invalid_escape) < 0) {
Eric V. Smith42454af2016-10-31 09:22:08 -04001268 Py_DECREF(result);
1269 return NULL;
1270 }
1271 }
1272 return result;
1273
1274}
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001275/* -------------------------------------------------------------------- */
1276/* object api */
1277
1278Py_ssize_t
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001279PyBytes_Size(PyObject *op)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001280{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001281 if (!PyBytes_Check(op)) {
1282 PyErr_Format(PyExc_TypeError,
1283 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
1284 return -1;
1285 }
1286 return Py_SIZE(op);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001287}
1288
1289char *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001290PyBytes_AsString(PyObject *op)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001291{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001292 if (!PyBytes_Check(op)) {
1293 PyErr_Format(PyExc_TypeError,
1294 "expected bytes, %.200s found", Py_TYPE(op)->tp_name);
1295 return NULL;
1296 }
1297 return ((PyBytesObject *)op)->ob_sval;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001298}
1299
1300int
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001301PyBytes_AsStringAndSize(PyObject *obj,
1302 char **s,
1303 Py_ssize_t *len)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001304{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001305 if (s == NULL) {
1306 PyErr_BadInternalCall();
1307 return -1;
1308 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001309
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001310 if (!PyBytes_Check(obj)) {
1311 PyErr_Format(PyExc_TypeError,
1312 "expected bytes, %.200s found", Py_TYPE(obj)->tp_name);
1313 return -1;
1314 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001315
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001316 *s = PyBytes_AS_STRING(obj);
1317 if (len != NULL)
1318 *len = PyBytes_GET_SIZE(obj);
1319 else if (strlen(*s) != (size_t)PyBytes_GET_SIZE(obj)) {
Serhiy Storchakad8a14472014-09-06 20:07:17 +03001320 PyErr_SetString(PyExc_ValueError,
1321 "embedded null byte");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001322 return -1;
1323 }
1324 return 0;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001325}
Neal Norwitz6968b052007-02-27 19:02:19 +00001326
1327/* -------------------------------------------------------------------- */
1328/* Methods */
1329
Eric Smith0923d1d2009-04-16 20:16:10 +00001330#include "stringlib/stringdefs.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001331
1332#include "stringlib/fastsearch.h"
1333#include "stringlib/count.h"
1334#include "stringlib/find.h"
Antoine Pitroucfc22b42012-10-16 21:07:23 +02001335#include "stringlib/join.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001336#include "stringlib/partition.h"
Antoine Pitrouf2c54842010-01-13 08:07:53 +00001337#include "stringlib/split.h"
Gregory P. Smith60d241f2007-10-16 06:31:30 +00001338#include "stringlib/ctype.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001339
Eric Smith0f78bff2009-11-30 01:01:42 +00001340#include "stringlib/transmogrify.h"
Neal Norwitz6968b052007-02-27 19:02:19 +00001341
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001342PyObject *
1343PyBytes_Repr(PyObject *obj, int smartquotes)
Neal Norwitz6968b052007-02-27 19:02:19 +00001344{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001345 PyBytesObject* op = (PyBytesObject*) obj;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001346 Py_ssize_t i, length = Py_SIZE(op);
Benjamin Petersond48bc942014-09-29 19:12:26 -04001347 Py_ssize_t newsize, squotes, dquotes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001348 PyObject *v;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001349 unsigned char quote, *s, *p;
1350
1351 /* Compute size of output string */
1352 squotes = dquotes = 0;
1353 newsize = 3; /* b'' */
1354 s = (unsigned char*)op->ob_sval;
1355 for (i = 0; i < length; i++) {
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001356 Py_ssize_t incr = 1;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001357 switch(s[i]) {
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001358 case '\'': squotes++; break;
1359 case '"': dquotes++; break;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001360 case '\\': case '\t': case '\n': case '\r':
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001361 incr = 2; break; /* \C */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001362 default:
1363 if (s[i] < ' ' || s[i] >= 0x7f)
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001364 incr = 4; /* \xHH */
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001365 }
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001366 if (newsize > PY_SSIZE_T_MAX - incr)
1367 goto overflow;
1368 newsize += incr;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001369 }
1370 quote = '\'';
1371 if (smartquotes && squotes && !dquotes)
1372 quote = '"';
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001373 if (squotes && quote == '\'') {
1374 if (newsize > PY_SSIZE_T_MAX - squotes)
1375 goto overflow;
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001376 newsize += squotes;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001377 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001378
1379 v = PyUnicode_New(newsize, 127);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001380 if (v == NULL) {
1381 return NULL;
1382 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001383 p = PyUnicode_1BYTE_DATA(v);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001384
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001385 *p++ = 'b', *p++ = quote;
1386 for (i = 0; i < length; i++) {
1387 unsigned char c = op->ob_sval[i];
1388 if (c == quote || c == '\\')
1389 *p++ = '\\', *p++ = c;
1390 else if (c == '\t')
1391 *p++ = '\\', *p++ = 't';
1392 else if (c == '\n')
1393 *p++ = '\\', *p++ = 'n';
1394 else if (c == '\r')
1395 *p++ = '\\', *p++ = 'r';
1396 else if (c < ' ' || c >= 0x7f) {
1397 *p++ = '\\';
1398 *p++ = 'x';
Victor Stinnerf5cff562011-10-14 02:13:11 +02001399 *p++ = Py_hexdigits[(c & 0xf0) >> 4];
1400 *p++ = Py_hexdigits[c & 0xf];
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001401 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001402 else
1403 *p++ = c;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001404 }
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001405 *p++ = quote;
Victor Stinner8f825062012-04-27 13:55:39 +02001406 assert(_PyUnicode_CheckConsistency(v, 1));
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02001407 return v;
Benjamin Peterson42ff1052014-09-29 19:01:18 -04001408
1409 overflow:
1410 PyErr_SetString(PyExc_OverflowError,
1411 "bytes object is too large to make repr");
1412 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001413}
1414
Neal Norwitz6968b052007-02-27 19:02:19 +00001415static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001416bytes_repr(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001417{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001418 return PyBytes_Repr(op, 1);
Neal Norwitz6968b052007-02-27 19:02:19 +00001419}
1420
Neal Norwitz6968b052007-02-27 19:02:19 +00001421static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001422bytes_str(PyObject *op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001423{
Victor Stinnerc96be812019-05-14 17:34:56 +02001424 _PyCoreConfig *config = &_PyInterpreterState_GET_UNSAFE()->core_config;
1425 if (config->bytes_warning) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001426 if (PyErr_WarnEx(PyExc_BytesWarning,
Victor Stinner53b7d4e2018-07-25 01:37:05 +02001427 "str() on a bytes instance", 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001428 return NULL;
Victor Stinner53b7d4e2018-07-25 01:37:05 +02001429 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001430 }
1431 return bytes_repr(op);
Neal Norwitz6968b052007-02-27 19:02:19 +00001432}
1433
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001434static Py_ssize_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001435bytes_length(PyBytesObject *a)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001436{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001437 return Py_SIZE(a);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001438}
Neal Norwitz6968b052007-02-27 19:02:19 +00001439
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001440/* This is also used by PyBytes_Concat() */
1441static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001442bytes_concat(PyObject *a, PyObject *b)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001443{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001444 Py_buffer va, vb;
1445 PyObject *result = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001446
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001447 va.len = -1;
1448 vb.len = -1;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001449 if (PyObject_GetBuffer(a, &va, PyBUF_SIMPLE) != 0 ||
1450 PyObject_GetBuffer(b, &vb, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001451 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
Serhiy Storchaka6b5a9ec2017-03-19 19:47:02 +02001452 Py_TYPE(b)->tp_name, Py_TYPE(a)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001453 goto done;
1454 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001455
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001456 /* Optimize end cases */
1457 if (va.len == 0 && PyBytes_CheckExact(b)) {
1458 result = b;
1459 Py_INCREF(result);
1460 goto done;
1461 }
1462 if (vb.len == 0 && PyBytes_CheckExact(a)) {
1463 result = a;
1464 Py_INCREF(result);
1465 goto done;
1466 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001467
Serhiy Storchaka06cfb0c2016-07-10 20:48:43 +03001468 if (va.len > PY_SSIZE_T_MAX - vb.len) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001469 PyErr_NoMemory();
1470 goto done;
1471 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001472
Serhiy Storchaka06cfb0c2016-07-10 20:48:43 +03001473 result = PyBytes_FromStringAndSize(NULL, va.len + vb.len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001474 if (result != NULL) {
1475 memcpy(PyBytes_AS_STRING(result), va.buf, va.len);
1476 memcpy(PyBytes_AS_STRING(result) + va.len, vb.buf, vb.len);
1477 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001478
1479 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001480 if (va.len != -1)
1481 PyBuffer_Release(&va);
1482 if (vb.len != -1)
1483 PyBuffer_Release(&vb);
1484 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001485}
Neal Norwitz6968b052007-02-27 19:02:19 +00001486
1487static PyObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001488bytes_repeat(PyBytesObject *a, Py_ssize_t n)
Neal Norwitz6968b052007-02-27 19:02:19 +00001489{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001490 Py_ssize_t i;
1491 Py_ssize_t j;
1492 Py_ssize_t size;
1493 PyBytesObject *op;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001494 size_t nbytes;
1495 if (n < 0)
1496 n = 0;
1497 /* watch out for overflows: the size can overflow int,
1498 * and the # of bytes needed can overflow size_t
1499 */
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001500 if (n > 0 && Py_SIZE(a) > PY_SSIZE_T_MAX / n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001501 PyErr_SetString(PyExc_OverflowError,
1502 "repeated bytes are too long");
1503 return NULL;
1504 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001505 size = Py_SIZE(a) * n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001506 if (size == Py_SIZE(a) && PyBytes_CheckExact(a)) {
1507 Py_INCREF(a);
1508 return (PyObject *)a;
1509 }
1510 nbytes = (size_t)size;
1511 if (nbytes + PyBytesObject_SIZE <= nbytes) {
1512 PyErr_SetString(PyExc_OverflowError,
1513 "repeated bytes are too long");
1514 return NULL;
1515 }
1516 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + nbytes);
1517 if (op == NULL)
1518 return PyErr_NoMemory();
Victor Stinnerb509d522018-11-23 14:27:38 +01001519 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001520 op->ob_shash = -1;
1521 op->ob_sval[size] = '\0';
1522 if (Py_SIZE(a) == 1 && n > 0) {
1523 memset(op->ob_sval, a->ob_sval[0] , n);
1524 return (PyObject *) op;
1525 }
1526 i = 0;
1527 if (i < size) {
Christian Heimesf051e432016-09-13 20:22:02 +02001528 memcpy(op->ob_sval, a->ob_sval, Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001529 i = Py_SIZE(a);
1530 }
1531 while (i < size) {
1532 j = (i <= size-i) ? i : size-i;
Christian Heimesf051e432016-09-13 20:22:02 +02001533 memcpy(op->ob_sval+i, op->ob_sval, j);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001534 i += j;
1535 }
1536 return (PyObject *) op;
Neal Norwitz6968b052007-02-27 19:02:19 +00001537}
1538
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001539static int
1540bytes_contains(PyObject *self, PyObject *arg)
1541{
1542 return _Py_bytes_contains(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), arg);
1543}
1544
Neal Norwitz6968b052007-02-27 19:02:19 +00001545static PyObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001546bytes_item(PyBytesObject *a, Py_ssize_t i)
Neal Norwitz6968b052007-02-27 19:02:19 +00001547{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001548 if (i < 0 || i >= Py_SIZE(a)) {
1549 PyErr_SetString(PyExc_IndexError, "index out of range");
1550 return NULL;
1551 }
1552 return PyLong_FromLong((unsigned char)a->ob_sval[i]);
Neal Norwitz6968b052007-02-27 19:02:19 +00001553}
1554
Benjamin Peterson621b4302016-09-09 13:54:34 -07001555static int
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001556bytes_compare_eq(PyBytesObject *a, PyBytesObject *b)
1557{
1558 int cmp;
1559 Py_ssize_t len;
1560
1561 len = Py_SIZE(a);
1562 if (Py_SIZE(b) != len)
1563 return 0;
1564
1565 if (a->ob_sval[0] != b->ob_sval[0])
1566 return 0;
1567
1568 cmp = memcmp(a->ob_sval, b->ob_sval, len);
1569 return (cmp == 0);
1570}
1571
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001572static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001573bytes_richcompare(PyBytesObject *a, PyBytesObject *b, int op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001574{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001575 int c;
1576 Py_ssize_t len_a, len_b;
1577 Py_ssize_t min_len;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001578 int rc;
Neal Norwitz6968b052007-02-27 19:02:19 +00001579
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001580 /* Make sure both arguments are strings. */
1581 if (!(PyBytes_Check(a) && PyBytes_Check(b))) {
Victor Stinnerc96be812019-05-14 17:34:56 +02001582 _PyCoreConfig *config = &_PyInterpreterState_GET_UNSAFE()->core_config;
1583 if (config->bytes_warning && (op == Py_EQ || op == Py_NE)) {
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001584 rc = PyObject_IsInstance((PyObject*)a,
1585 (PyObject*)&PyUnicode_Type);
1586 if (!rc)
1587 rc = PyObject_IsInstance((PyObject*)b,
1588 (PyObject*)&PyUnicode_Type);
1589 if (rc < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001590 return NULL;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001591 if (rc) {
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001592 if (PyErr_WarnEx(PyExc_BytesWarning,
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001593 "Comparison between bytes and string", 1))
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001594 return NULL;
1595 }
Serhiy Storchakaac5569b2015-05-30 17:48:19 +03001596 else {
1597 rc = PyObject_IsInstance((PyObject*)a,
1598 (PyObject*)&PyLong_Type);
1599 if (!rc)
1600 rc = PyObject_IsInstance((PyObject*)b,
1601 (PyObject*)&PyLong_Type);
1602 if (rc < 0)
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001603 return NULL;
Serhiy Storchakaac5569b2015-05-30 17:48:19 +03001604 if (rc) {
1605 if (PyErr_WarnEx(PyExc_BytesWarning,
1606 "Comparison between bytes and int", 1))
1607 return NULL;
1608 }
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001609 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 }
stratakise8b19652017-11-02 11:32:54 +01001611 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001613 else if (a == b) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001614 switch (op) {
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001615 case Py_EQ:
1616 case Py_LE:
1617 case Py_GE:
1618 /* a string is equal to itself */
stratakise8b19652017-11-02 11:32:54 +01001619 Py_RETURN_TRUE;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001620 break;
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001621 case Py_NE:
1622 case Py_LT:
1623 case Py_GT:
stratakise8b19652017-11-02 11:32:54 +01001624 Py_RETURN_FALSE;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001625 break;
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001626 default:
1627 PyErr_BadArgument();
1628 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001629 }
1630 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001631 else if (op == Py_EQ || op == Py_NE) {
1632 int eq = bytes_compare_eq(a, b);
1633 eq ^= (op == Py_NE);
stratakise8b19652017-11-02 11:32:54 +01001634 return PyBool_FromLong(eq);
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001635 }
1636 else {
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001637 len_a = Py_SIZE(a);
1638 len_b = Py_SIZE(b);
1639 min_len = Py_MIN(len_a, len_b);
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001640 if (min_len > 0) {
1641 c = Py_CHARMASK(*a->ob_sval) - Py_CHARMASK(*b->ob_sval);
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001642 if (c == 0)
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001643 c = memcmp(a->ob_sval, b->ob_sval, min_len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001644 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001645 else
1646 c = 0;
stratakise8b19652017-11-02 11:32:54 +01001647 if (c != 0)
1648 Py_RETURN_RICHCOMPARE(c, 0, op);
1649 Py_RETURN_RICHCOMPARE(len_a, len_b, op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001650 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001651}
1652
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001653static Py_hash_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001654bytes_hash(PyBytesObject *a)
Neal Norwitz6968b052007-02-27 19:02:19 +00001655{
Antoine Pitrouce4a9da2011-11-21 20:46:33 +01001656 if (a->ob_shash == -1) {
1657 /* Can't fail */
Christian Heimes985ecdc2013-11-20 11:46:18 +01001658 a->ob_shash = _Py_HashBytes(a->ob_sval, Py_SIZE(a));
Antoine Pitrouce4a9da2011-11-21 20:46:33 +01001659 }
1660 return a->ob_shash;
Neal Norwitz6968b052007-02-27 19:02:19 +00001661}
1662
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001663static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001664bytes_subscript(PyBytesObject* self, PyObject* item)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001665{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001666 if (PyIndex_Check(item)) {
1667 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1668 if (i == -1 && PyErr_Occurred())
1669 return NULL;
1670 if (i < 0)
1671 i += PyBytes_GET_SIZE(self);
1672 if (i < 0 || i >= PyBytes_GET_SIZE(self)) {
1673 PyErr_SetString(PyExc_IndexError,
1674 "index out of range");
1675 return NULL;
1676 }
1677 return PyLong_FromLong((unsigned char)self->ob_sval[i]);
1678 }
1679 else if (PySlice_Check(item)) {
1680 Py_ssize_t start, stop, step, slicelength, cur, i;
1681 char* source_buf;
1682 char* result_buf;
1683 PyObject* result;
Neal Norwitz6968b052007-02-27 19:02:19 +00001684
Serhiy Storchakab879fe82017-04-08 09:53:51 +03001685 if (PySlice_Unpack(item, &start, &stop, &step) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001686 return NULL;
1687 }
Serhiy Storchakab879fe82017-04-08 09:53:51 +03001688 slicelength = PySlice_AdjustIndices(PyBytes_GET_SIZE(self), &start,
1689 &stop, step);
Neal Norwitz6968b052007-02-27 19:02:19 +00001690
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001691 if (slicelength <= 0) {
1692 return PyBytes_FromStringAndSize("", 0);
1693 }
1694 else if (start == 0 && step == 1 &&
1695 slicelength == PyBytes_GET_SIZE(self) &&
1696 PyBytes_CheckExact(self)) {
1697 Py_INCREF(self);
1698 return (PyObject *)self;
1699 }
1700 else if (step == 1) {
1701 return PyBytes_FromStringAndSize(
1702 PyBytes_AS_STRING(self) + start,
1703 slicelength);
1704 }
1705 else {
1706 source_buf = PyBytes_AS_STRING(self);
1707 result = PyBytes_FromStringAndSize(NULL, slicelength);
1708 if (result == NULL)
1709 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001710
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001711 result_buf = PyBytes_AS_STRING(result);
1712 for (cur = start, i = 0; i < slicelength;
1713 cur += step, i++) {
1714 result_buf[i] = source_buf[cur];
1715 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001716
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001717 return result;
1718 }
1719 }
1720 else {
1721 PyErr_Format(PyExc_TypeError,
Terry Jan Reedyffff1442014-08-02 01:30:37 -04001722 "byte indices must be integers or slices, not %.200s",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001723 Py_TYPE(item)->tp_name);
1724 return NULL;
1725 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001726}
1727
1728static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001729bytes_buffer_getbuffer(PyBytesObject *self, Py_buffer *view, int flags)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001730{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001731 return PyBuffer_FillInfo(view, (PyObject*)self, (void *)self->ob_sval, Py_SIZE(self),
1732 1, flags);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001733}
1734
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001735static PySequenceMethods bytes_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001736 (lenfunc)bytes_length, /*sq_length*/
1737 (binaryfunc)bytes_concat, /*sq_concat*/
1738 (ssizeargfunc)bytes_repeat, /*sq_repeat*/
1739 (ssizeargfunc)bytes_item, /*sq_item*/
1740 0, /*sq_slice*/
1741 0, /*sq_ass_item*/
1742 0, /*sq_ass_slice*/
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001743 (objobjproc)bytes_contains /*sq_contains*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001744};
1745
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001746static PyMappingMethods bytes_as_mapping = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001747 (lenfunc)bytes_length,
1748 (binaryfunc)bytes_subscript,
1749 0,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001750};
1751
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001752static PyBufferProcs bytes_as_buffer = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001753 (getbufferproc)bytes_buffer_getbuffer,
1754 NULL,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001755};
1756
1757
1758#define LEFTSTRIP 0
1759#define RIGHTSTRIP 1
1760#define BOTHSTRIP 2
1761
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001762/*[clinic input]
1763bytes.split
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001764
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001765 sep: object = None
1766 The delimiter according which to split the bytes.
1767 None (the default value) means split on ASCII whitespace characters
1768 (space, tab, return, newline, formfeed, vertical tab).
1769 maxsplit: Py_ssize_t = -1
1770 Maximum number of splits to do.
1771 -1 (the default value) means no limit.
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001772
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001773Return a list of the sections in the bytes, using sep as the delimiter.
1774[clinic start generated code]*/
1775
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001776static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001777bytes_split_impl(PyBytesObject *self, PyObject *sep, Py_ssize_t maxsplit)
1778/*[clinic end generated code: output=52126b5844c1d8ef input=8b809b39074abbfa]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001779{
1780 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001781 const char *s = PyBytes_AS_STRING(self), *sub;
1782 Py_buffer vsub;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001783 PyObject *list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001784
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001785 if (maxsplit < 0)
1786 maxsplit = PY_SSIZE_T_MAX;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001787 if (sep == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 return stringlib_split_whitespace((PyObject*) self, s, len, maxsplit);
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001789 if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001790 return NULL;
1791 sub = vsub.buf;
1792 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001793
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001794 list = stringlib_split((PyObject*) self, s, len, sub, n, maxsplit);
1795 PyBuffer_Release(&vsub);
1796 return list;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001797}
1798
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001799/*[clinic input]
1800bytes.partition
1801
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001802 sep: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001803 /
1804
1805Partition the bytes into three parts using the given separator.
1806
1807This will search for the separator sep in the bytes. If the separator is found,
1808returns a 3-tuple containing the part before the separator, the separator
1809itself, and the part after it.
1810
1811If the separator is not found, returns a 3-tuple containing the original bytes
1812object and two empty bytes objects.
1813[clinic start generated code]*/
1814
Neal Norwitz6968b052007-02-27 19:02:19 +00001815static PyObject *
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001816bytes_partition_impl(PyBytesObject *self, Py_buffer *sep)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001817/*[clinic end generated code: output=f532b392a17ff695 input=61cca95519406099]*/
Neal Norwitz6968b052007-02-27 19:02:19 +00001818{
Neal Norwitz6968b052007-02-27 19:02:19 +00001819 return stringlib_partition(
1820 (PyObject*) self,
1821 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001822 sep->obj, (const char *)sep->buf, sep->len
Neal Norwitz6968b052007-02-27 19:02:19 +00001823 );
1824}
1825
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001826/*[clinic input]
1827bytes.rpartition
1828
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001829 sep: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001830 /
1831
1832Partition the bytes into three parts using the given separator.
1833
Serhiy Storchakaa2314282017-10-29 02:11:54 +03001834This will search for the separator sep in the bytes, starting at the end. If
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001835the separator is found, returns a 3-tuple containing the part before the
1836separator, the separator itself, and the part after it.
1837
1838If the separator is not found, returns a 3-tuple containing two empty bytes
1839objects and the original bytes object.
1840[clinic start generated code]*/
1841
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001842static PyObject *
1843bytes_rpartition_impl(PyBytesObject *self, Py_buffer *sep)
Serhiy Storchakaa2314282017-10-29 02:11:54 +03001844/*[clinic end generated code: output=191b114cbb028e50 input=d78db010c8cfdbe1]*/
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001845{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001846 return stringlib_rpartition(
1847 (PyObject*) self,
1848 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001849 sep->obj, (const char *)sep->buf, sep->len
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001850 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001851}
1852
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001853/*[clinic input]
1854bytes.rsplit = bytes.split
Neal Norwitz6968b052007-02-27 19:02:19 +00001855
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001856Return a list of the sections in the bytes, using sep as the delimiter.
1857
1858Splitting is done starting at the end of the bytes and working to the front.
1859[clinic start generated code]*/
1860
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001861static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001862bytes_rsplit_impl(PyBytesObject *self, PyObject *sep, Py_ssize_t maxsplit)
1863/*[clinic end generated code: output=ba698d9ea01e1c8f input=0f86c9f28f7d7b7b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001864{
1865 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001866 const char *s = PyBytes_AS_STRING(self), *sub;
1867 Py_buffer vsub;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001868 PyObject *list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001869
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001870 if (maxsplit < 0)
1871 maxsplit = PY_SSIZE_T_MAX;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001872 if (sep == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 return stringlib_rsplit_whitespace((PyObject*) self, s, len, maxsplit);
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001874 if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001875 return NULL;
1876 sub = vsub.buf;
1877 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001878
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001879 list = stringlib_rsplit((PyObject*) self, s, len, sub, n, maxsplit);
1880 PyBuffer_Release(&vsub);
1881 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001882}
1883
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001884
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001885/*[clinic input]
1886bytes.join
1887
1888 iterable_of_bytes: object
1889 /
1890
1891Concatenate any number of bytes objects.
1892
1893The bytes whose method is called is inserted in between each pair.
1894
1895The result is returned as a new bytes object.
1896
1897Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.
1898[clinic start generated code]*/
1899
Neal Norwitz6968b052007-02-27 19:02:19 +00001900static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001901bytes_join(PyBytesObject *self, PyObject *iterable_of_bytes)
1902/*[clinic end generated code: output=a046f379f626f6f8 input=7fe377b95bd549d2]*/
Neal Norwitz6968b052007-02-27 19:02:19 +00001903{
Martin v. Löwis0efea322014-07-27 17:29:17 +02001904 return stringlib_bytes_join((PyObject*)self, iterable_of_bytes);
Neal Norwitz6968b052007-02-27 19:02:19 +00001905}
1906
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001907PyObject *
1908_PyBytes_Join(PyObject *sep, PyObject *x)
1909{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001910 assert(sep != NULL && PyBytes_Check(sep));
1911 assert(x != NULL);
Martin v. Löwis0efea322014-07-27 17:29:17 +02001912 return bytes_join((PyBytesObject*)sep, x);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001913}
1914
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001915static PyObject *
1916bytes_find(PyBytesObject *self, PyObject *args)
1917{
1918 return _Py_bytes_find(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1919}
1920
1921static PyObject *
1922bytes_index(PyBytesObject *self, PyObject *args)
1923{
1924 return _Py_bytes_index(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1925}
1926
1927
1928static PyObject *
1929bytes_rfind(PyBytesObject *self, PyObject *args)
1930{
1931 return _Py_bytes_rfind(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1932}
1933
1934
1935static PyObject *
1936bytes_rindex(PyBytesObject *self, PyObject *args)
1937{
1938 return _Py_bytes_rindex(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1939}
1940
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001941
1942Py_LOCAL_INLINE(PyObject *)
1943do_xstrip(PyBytesObject *self, int striptype, PyObject *sepobj)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001944{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001945 Py_buffer vsep;
1946 char *s = PyBytes_AS_STRING(self);
1947 Py_ssize_t len = PyBytes_GET_SIZE(self);
1948 char *sep;
1949 Py_ssize_t seplen;
1950 Py_ssize_t i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001951
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001952 if (PyObject_GetBuffer(sepobj, &vsep, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001953 return NULL;
1954 sep = vsep.buf;
1955 seplen = vsep.len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001956
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001957 i = 0;
1958 if (striptype != RIGHTSTRIP) {
1959 while (i < len && memchr(sep, Py_CHARMASK(s[i]), seplen)) {
1960 i++;
1961 }
1962 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001963
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001964 j = len;
1965 if (striptype != LEFTSTRIP) {
1966 do {
1967 j--;
1968 } while (j >= i && memchr(sep, Py_CHARMASK(s[j]), seplen));
1969 j++;
1970 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 PyBuffer_Release(&vsep);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001973
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001974 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1975 Py_INCREF(self);
1976 return (PyObject*)self;
1977 }
1978 else
1979 return PyBytes_FromStringAndSize(s+i, j-i);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001980}
1981
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001982
1983Py_LOCAL_INLINE(PyObject *)
1984do_strip(PyBytesObject *self, int striptype)
1985{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001986 char *s = PyBytes_AS_STRING(self);
1987 Py_ssize_t len = PyBytes_GET_SIZE(self), i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001988
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001989 i = 0;
1990 if (striptype != RIGHTSTRIP) {
David Malcolm96960882010-11-05 17:23:41 +00001991 while (i < len && Py_ISSPACE(s[i])) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001992 i++;
1993 }
1994 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001995
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001996 j = len;
1997 if (striptype != LEFTSTRIP) {
1998 do {
1999 j--;
David Malcolm96960882010-11-05 17:23:41 +00002000 } while (j >= i && Py_ISSPACE(s[j]));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002001 j++;
2002 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002003
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002004 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
2005 Py_INCREF(self);
2006 return (PyObject*)self;
2007 }
2008 else
2009 return PyBytes_FromStringAndSize(s+i, j-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002010}
2011
2012
2013Py_LOCAL_INLINE(PyObject *)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002014do_argstrip(PyBytesObject *self, int striptype, PyObject *bytes)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002015{
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002016 if (bytes != NULL && bytes != Py_None) {
2017 return do_xstrip(self, striptype, bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002018 }
2019 return do_strip(self, striptype);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002020}
2021
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002022/*[clinic input]
2023bytes.strip
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002024
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002025 bytes: object = None
2026 /
2027
2028Strip leading and trailing bytes contained in the argument.
2029
2030If the argument is omitted or None, strip leading and trailing ASCII whitespace.
2031[clinic start generated code]*/
2032
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002033static PyObject *
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002034bytes_strip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002035/*[clinic end generated code: output=c7c228d3bd104a1b input=8a354640e4e0b3ef]*/
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002036{
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002037 return do_argstrip(self, BOTHSTRIP, bytes);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002038}
2039
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002040/*[clinic input]
2041bytes.lstrip
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002042
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002043 bytes: object = None
2044 /
2045
2046Strip leading bytes contained in the argument.
2047
2048If the argument is omitted or None, strip leading ASCII whitespace.
2049[clinic start generated code]*/
2050
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002051static PyObject *
2052bytes_lstrip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002053/*[clinic end generated code: output=28602e586f524e82 input=9baff4398c3f6857]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002054{
2055 return do_argstrip(self, LEFTSTRIP, bytes);
2056}
2057
2058/*[clinic input]
2059bytes.rstrip
2060
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002061 bytes: object = None
2062 /
2063
2064Strip trailing bytes contained in the argument.
2065
2066If the argument is omitted or None, strip trailing ASCII whitespace.
2067[clinic start generated code]*/
2068
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002069static PyObject *
2070bytes_rstrip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002071/*[clinic end generated code: output=547e3815c95447da input=b78af445c727e32b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002072{
2073 return do_argstrip(self, RIGHTSTRIP, bytes);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002074}
Neal Norwitz6968b052007-02-27 19:02:19 +00002075
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002076
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002077static PyObject *
2078bytes_count(PyBytesObject *self, PyObject *args)
2079{
2080 return _Py_bytes_count(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2081}
2082
2083
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002084/*[clinic input]
2085bytes.translate
2086
Victor Stinner049e5092014-08-17 22:20:00 +02002087 table: object
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002088 Translation table, which must be a bytes object of length 256.
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002089 /
Martin Panter1b6c6da2016-08-27 08:35:02 +00002090 delete as deletechars: object(c_default="NULL") = b''
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002091
2092Return a copy with each character mapped by the given translation table.
2093
Martin Panter1b6c6da2016-08-27 08:35:02 +00002094All characters occurring in the optional argument delete are removed.
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002095The remaining characters are mapped through the given translation table.
2096[clinic start generated code]*/
2097
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002098static PyObject *
Martin Panter1b6c6da2016-08-27 08:35:02 +00002099bytes_translate_impl(PyBytesObject *self, PyObject *table,
Larry Hastings89964c42015-04-14 18:07:59 -04002100 PyObject *deletechars)
Martin Panter1b6c6da2016-08-27 08:35:02 +00002101/*[clinic end generated code: output=43be3437f1956211 input=0ecdf159f654233c]*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002102{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002103 char *input, *output;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002104 Py_buffer table_view = {NULL, NULL};
2105 Py_buffer del_table_view = {NULL, NULL};
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002106 const char *table_chars;
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002107 Py_ssize_t i, c, changed = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 PyObject *input_obj = (PyObject*)self;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002109 const char *output_start, *del_table_chars=NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002110 Py_ssize_t inlen, tablen, dellen = 0;
2111 PyObject *result;
2112 int trans_table[256];
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002113
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002114 if (PyBytes_Check(table)) {
2115 table_chars = PyBytes_AS_STRING(table);
2116 tablen = PyBytes_GET_SIZE(table);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002117 }
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002118 else if (table == Py_None) {
2119 table_chars = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002120 tablen = 256;
2121 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002122 else {
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002123 if (PyObject_GetBuffer(table, &table_view, PyBUF_SIMPLE) != 0)
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002124 return NULL;
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002125 table_chars = table_view.buf;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002126 tablen = table_view.len;
2127 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002128
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002129 if (tablen != 256) {
2130 PyErr_SetString(PyExc_ValueError,
2131 "translation table must be 256 characters long");
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002132 PyBuffer_Release(&table_view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002133 return NULL;
2134 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002135
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002136 if (deletechars != NULL) {
2137 if (PyBytes_Check(deletechars)) {
2138 del_table_chars = PyBytes_AS_STRING(deletechars);
2139 dellen = PyBytes_GET_SIZE(deletechars);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002140 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002141 else {
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002142 if (PyObject_GetBuffer(deletechars, &del_table_view, PyBUF_SIMPLE) != 0) {
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002143 PyBuffer_Release(&table_view);
2144 return NULL;
2145 }
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002146 del_table_chars = del_table_view.buf;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002147 dellen = del_table_view.len;
2148 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002149 }
2150 else {
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002151 del_table_chars = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002152 dellen = 0;
2153 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002154
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002155 inlen = PyBytes_GET_SIZE(input_obj);
2156 result = PyBytes_FromStringAndSize((char *)NULL, inlen);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002157 if (result == NULL) {
2158 PyBuffer_Release(&del_table_view);
2159 PyBuffer_Release(&table_view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002160 return NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002161 }
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002162 output_start = output = PyBytes_AS_STRING(result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002163 input = PyBytes_AS_STRING(input_obj);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002164
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002165 if (dellen == 0 && table_chars != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002166 /* If no deletions are required, use faster code */
2167 for (i = inlen; --i >= 0; ) {
2168 c = Py_CHARMASK(*input++);
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002169 if (Py_CHARMASK((*output++ = table_chars[c])) != c)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002170 changed = 1;
2171 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002172 if (!changed && PyBytes_CheckExact(input_obj)) {
2173 Py_INCREF(input_obj);
2174 Py_DECREF(result);
2175 result = input_obj;
2176 }
2177 PyBuffer_Release(&del_table_view);
2178 PyBuffer_Release(&table_view);
2179 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002180 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002181
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002182 if (table_chars == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002183 for (i = 0; i < 256; i++)
2184 trans_table[i] = Py_CHARMASK(i);
2185 } else {
2186 for (i = 0; i < 256; i++)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002187 trans_table[i] = Py_CHARMASK(table_chars[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002188 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002189 PyBuffer_Release(&table_view);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002190
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002191 for (i = 0; i < dellen; i++)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002192 trans_table[(int) Py_CHARMASK(del_table_chars[i])] = -1;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002193 PyBuffer_Release(&del_table_view);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002194
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002195 for (i = inlen; --i >= 0; ) {
2196 c = Py_CHARMASK(*input++);
2197 if (trans_table[c] != -1)
2198 if (Py_CHARMASK(*output++ = (char)trans_table[c]) == c)
2199 continue;
2200 changed = 1;
2201 }
2202 if (!changed && PyBytes_CheckExact(input_obj)) {
2203 Py_DECREF(result);
2204 Py_INCREF(input_obj);
2205 return input_obj;
2206 }
2207 /* Fix the size of the resulting string */
2208 if (inlen > 0)
2209 _PyBytes_Resize(&result, output - output_start);
2210 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002211}
2212
2213
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002214/*[clinic input]
2215
2216@staticmethod
2217bytes.maketrans
2218
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002219 frm: Py_buffer
2220 to: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002221 /
2222
2223Return a translation table useable for the bytes or bytearray translate method.
2224
2225The returned table will be one where each byte in frm is mapped to the byte at
2226the same position in to.
2227
2228The bytes objects frm and to must be of the same length.
2229[clinic start generated code]*/
2230
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002231static PyObject *
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002232bytes_maketrans_impl(Py_buffer *frm, Py_buffer *to)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03002233/*[clinic end generated code: output=a36f6399d4b77f6f input=de7a8fc5632bb8f1]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002234{
2235 return _Py_bytes_maketrans(frm, to);
Georg Brandlabc38772009-04-12 15:51:51 +00002236}
2237
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002238
2239/*[clinic input]
2240bytes.replace
2241
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002242 old: Py_buffer
2243 new: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002244 count: Py_ssize_t = -1
2245 Maximum number of occurrences to replace.
2246 -1 (the default value) means replace all occurrences.
2247 /
2248
2249Return a copy with all occurrences of substring old replaced by new.
2250
2251If the optional argument count is given, only the first count occurrences are
2252replaced.
2253[clinic start generated code]*/
2254
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002255static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002256bytes_replace_impl(PyBytesObject *self, Py_buffer *old, Py_buffer *new,
Larry Hastings89964c42015-04-14 18:07:59 -04002257 Py_ssize_t count)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002258/*[clinic end generated code: output=994fa588b6b9c104 input=b2fbbf0bf04de8e5]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002259{
Serhiy Storchakafb81d3c2016-05-05 09:26:07 +03002260 return stringlib_replace((PyObject *)self,
2261 (const char *)old->buf, old->len,
2262 (const char *)new->buf, new->len, count);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002263}
2264
2265/** End DALKE **/
2266
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002267
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002268static PyObject *
2269bytes_startswith(PyBytesObject *self, PyObject *args)
2270{
2271 return _Py_bytes_startswith(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2272}
2273
2274static PyObject *
2275bytes_endswith(PyBytesObject *self, PyObject *args)
2276{
2277 return _Py_bytes_endswith(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2278}
2279
2280
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002281/*[clinic input]
2282bytes.decode
2283
2284 encoding: str(c_default="NULL") = 'utf-8'
2285 The encoding with which to decode the bytes.
2286 errors: str(c_default="NULL") = 'strict'
2287 The error handling scheme to use for the handling of decoding errors.
2288 The default is 'strict' meaning that decoding errors raise a
2289 UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
2290 as well as any other name registered with codecs.register_error that
2291 can handle UnicodeDecodeErrors.
2292
2293Decode the bytes using the codec registered for encoding.
2294[clinic start generated code]*/
2295
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002296static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002297bytes_decode_impl(PyBytesObject *self, const char *encoding,
Larry Hastings89964c42015-04-14 18:07:59 -04002298 const char *errors)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002299/*[clinic end generated code: output=5649a53dde27b314 input=958174769d2a40ca]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002300{
Martin v. Löwis0efea322014-07-27 17:29:17 +02002301 return PyUnicode_FromEncodedObject((PyObject*)self, encoding, errors);
Guido van Rossumd624f182006-04-24 13:47:05 +00002302}
2303
Guido van Rossum20188312006-05-05 15:15:40 +00002304
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002305/*[clinic input]
2306bytes.splitlines
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002307
Serhiy Storchaka202fda52017-03-12 10:10:47 +02002308 keepends: bool(accept={int}) = False
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002309
2310Return a list of the lines in the bytes, breaking at line boundaries.
2311
2312Line breaks are not included in the resulting list unless keepends is given and
2313true.
2314[clinic start generated code]*/
2315
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002316static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002317bytes_splitlines_impl(PyBytesObject *self, int keepends)
Serhiy Storchaka202fda52017-03-12 10:10:47 +02002318/*[clinic end generated code: output=3484149a5d880ffb input=a8b32eb01ff5a5ed]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002319{
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002320 return stringlib_splitlines(
Antoine Pitroud1188562010-06-09 16:38:55 +00002321 (PyObject*) self, PyBytes_AS_STRING(self),
2322 PyBytes_GET_SIZE(self), keepends
2323 );
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002324}
2325
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002326/*[clinic input]
2327@classmethod
2328bytes.fromhex
2329
2330 string: unicode
2331 /
2332
2333Create a bytes object from a string of hexadecimal numbers.
2334
2335Spaces between two numbers are accepted.
2336Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.
2337[clinic start generated code]*/
2338
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002339static PyObject *
Martin v. Löwis0efea322014-07-27 17:29:17 +02002340bytes_fromhex_impl(PyTypeObject *type, PyObject *string)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03002341/*[clinic end generated code: output=0973acc63661bb2e input=bf4d1c361670acd3]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002342{
Serhiy Storchaka0855e702016-07-01 17:22:31 +03002343 PyObject *result = _PyBytes_FromHex(string, 0);
2344 if (type != &PyBytes_Type && result != NULL) {
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01002345 Py_SETREF(result, PyObject_CallFunctionObjArgs((PyObject *)type,
2346 result, NULL));
Serhiy Storchaka0855e702016-07-01 17:22:31 +03002347 }
2348 return result;
Victor Stinner2bf89932015-10-14 11:25:33 +02002349}
2350
2351PyObject*
2352_PyBytes_FromHex(PyObject *string, int use_bytearray)
2353{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002354 char *buf;
Victor Stinner2bf89932015-10-14 11:25:33 +02002355 Py_ssize_t hexlen, invalid_char;
2356 unsigned int top, bot;
2357 Py_UCS1 *str, *end;
2358 _PyBytesWriter writer;
2359
2360 _PyBytesWriter_Init(&writer);
2361 writer.use_bytearray = use_bytearray;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002362
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002363 assert(PyUnicode_Check(string));
2364 if (PyUnicode_READY(string))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002365 return NULL;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002366 hexlen = PyUnicode_GET_LENGTH(string);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002367
Victor Stinner2bf89932015-10-14 11:25:33 +02002368 if (!PyUnicode_IS_ASCII(string)) {
2369 void *data = PyUnicode_DATA(string);
2370 unsigned int kind = PyUnicode_KIND(string);
2371 Py_ssize_t i;
2372
2373 /* search for the first non-ASCII character */
2374 for (i = 0; i < hexlen; i++) {
2375 if (PyUnicode_READ(kind, data, i) >= 128)
2376 break;
2377 }
2378 invalid_char = i;
2379 goto error;
2380 }
2381
2382 assert(PyUnicode_KIND(string) == PyUnicode_1BYTE_KIND);
2383 str = PyUnicode_1BYTE_DATA(string);
2384
2385 /* This overestimates if there are spaces */
2386 buf = _PyBytesWriter_Alloc(&writer, hexlen / 2);
2387 if (buf == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002388 return NULL;
Victor Stinner2bf89932015-10-14 11:25:33 +02002389
2390 end = str + hexlen;
2391 while (str < end) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002392 /* skip over spaces in the input */
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +02002393 if (Py_ISSPACE(*str)) {
Victor Stinner2bf89932015-10-14 11:25:33 +02002394 do {
2395 str++;
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +02002396 } while (Py_ISSPACE(*str));
Victor Stinner2bf89932015-10-14 11:25:33 +02002397 if (str >= end)
2398 break;
2399 }
2400
2401 top = _PyLong_DigitValue[*str];
2402 if (top >= 16) {
2403 invalid_char = str - PyUnicode_1BYTE_DATA(string);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002404 goto error;
2405 }
Victor Stinner2bf89932015-10-14 11:25:33 +02002406 str++;
2407
2408 bot = _PyLong_DigitValue[*str];
2409 if (bot >= 16) {
2410 invalid_char = str - PyUnicode_1BYTE_DATA(string);
2411 goto error;
2412 }
2413 str++;
2414
2415 *buf++ = (unsigned char)((top << 4) + bot);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002416 }
Victor Stinner2bf89932015-10-14 11:25:33 +02002417
2418 return _PyBytesWriter_Finish(&writer, buf);
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002419
2420 error:
Victor Stinner2bf89932015-10-14 11:25:33 +02002421 PyErr_Format(PyExc_ValueError,
2422 "non-hexadecimal number found in "
2423 "fromhex() arg at position %zd", invalid_char);
2424 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002425 return NULL;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002426}
2427
Gregory P. Smith8cb65692015-04-25 23:22:26 +00002428PyDoc_STRVAR(hex__doc__,
2429"B.hex() -> string\n\
2430\n\
2431Create a string of hexadecimal numbers from a bytes object.\n\
2432Example: b'\\xb9\\x01\\xef'.hex() -> 'b901ef'.");
2433
2434static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302435bytes_hex(PyBytesObject *self, PyObject *Py_UNUSED(ignored))
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002436{
2437 char* argbuf = PyBytes_AS_STRING(self);
2438 Py_ssize_t arglen = PyBytes_GET_SIZE(self);
2439 return _Py_strhex(argbuf, arglen);
2440}
2441
2442static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302443bytes_getnewargs(PyBytesObject *v, PyObject *Py_UNUSED(ignored))
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002444{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002445 return Py_BuildValue("(y#)", v->ob_sval, Py_SIZE(v));
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002446}
2447
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002448
2449static PyMethodDef
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002450bytes_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 {"__getnewargs__", (PyCFunction)bytes_getnewargs, METH_NOARGS},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302452 {"capitalize", stringlib_capitalize, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002453 _Py_capitalize__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002454 STRINGLIB_CENTER_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002455 {"count", (PyCFunction)bytes_count, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002456 _Py_count__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002457 BYTES_DECODE_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002458 {"endswith", (PyCFunction)bytes_endswith, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002459 _Py_endswith__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002460 STRINGLIB_EXPANDTABS_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002461 {"find", (PyCFunction)bytes_find, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002462 _Py_find__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002463 BYTES_FROMHEX_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002464 {"hex", (PyCFunction)bytes_hex, METH_NOARGS, hex__doc__},
2465 {"index", (PyCFunction)bytes_index, METH_VARARGS, _Py_index__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302466 {"isalnum", stringlib_isalnum, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 _Py_isalnum__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302468 {"isalpha", stringlib_isalpha, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002469 _Py_isalpha__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302470 {"isascii", stringlib_isascii, METH_NOARGS,
INADA Naokia49ac992018-01-27 14:06:21 +09002471 _Py_isascii__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302472 {"isdigit", stringlib_isdigit, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 _Py_isdigit__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302474 {"islower", stringlib_islower, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 _Py_islower__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302476 {"isspace", stringlib_isspace, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 _Py_isspace__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302478 {"istitle", stringlib_istitle, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 _Py_istitle__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302480 {"isupper", stringlib_isupper, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002481 _Py_isupper__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002482 BYTES_JOIN_METHODDEF
Tal Einatc929df32018-07-06 13:17:38 +03002483 STRINGLIB_LJUST_METHODDEF
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302484 {"lower", stringlib_lower, METH_NOARGS, _Py_lower__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002485 BYTES_LSTRIP_METHODDEF
2486 BYTES_MAKETRANS_METHODDEF
2487 BYTES_PARTITION_METHODDEF
2488 BYTES_REPLACE_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002489 {"rfind", (PyCFunction)bytes_rfind, METH_VARARGS, _Py_rfind__doc__},
2490 {"rindex", (PyCFunction)bytes_rindex, METH_VARARGS, _Py_rindex__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002491 STRINGLIB_RJUST_METHODDEF
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002492 BYTES_RPARTITION_METHODDEF
2493 BYTES_RSPLIT_METHODDEF
2494 BYTES_RSTRIP_METHODDEF
2495 BYTES_SPLIT_METHODDEF
2496 BYTES_SPLITLINES_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002497 {"startswith", (PyCFunction)bytes_startswith, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002498 _Py_startswith__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002499 BYTES_STRIP_METHODDEF
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302500 {"swapcase", stringlib_swapcase, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002501 _Py_swapcase__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302502 {"title", stringlib_title, METH_NOARGS, _Py_title__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002503 BYTES_TRANSLATE_METHODDEF
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302504 {"upper", stringlib_upper, METH_NOARGS, _Py_upper__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002505 STRINGLIB_ZFILL_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002506 {NULL, NULL} /* sentinel */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002507};
2508
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002509static PyObject *
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002510bytes_mod(PyObject *self, PyObject *arg)
Ethan Furmanb95b5612015-01-23 20:05:18 -08002511{
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002512 if (!PyBytes_Check(self)) {
2513 Py_RETURN_NOTIMPLEMENTED;
Victor Stinner772b2b02015-10-14 09:56:53 +02002514 }
Victor Stinner772b2b02015-10-14 09:56:53 +02002515 return _PyBytes_FormatEx(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002516 arg, 0);
Ethan Furmanb95b5612015-01-23 20:05:18 -08002517}
2518
2519static PyNumberMethods bytes_as_number = {
2520 0, /*nb_add*/
2521 0, /*nb_subtract*/
2522 0, /*nb_multiply*/
2523 bytes_mod, /*nb_remainder*/
2524};
2525
2526static PyObject *
Serhiy Storchaka15095802015-11-25 15:47:01 +02002527bytes_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002528
2529static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002530bytes_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002531{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002532 PyObject *x = NULL;
2533 const char *encoding = NULL;
2534 const char *errors = NULL;
2535 PyObject *new = NULL;
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002536 PyObject *func;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002537 Py_ssize_t size;
2538 static char *kwlist[] = {"source", "encoding", "errors", 0};
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002539 _Py_IDENTIFIER(__bytes__);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002540
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (type != &PyBytes_Type)
Serhiy Storchaka15095802015-11-25 15:47:01 +02002542 return bytes_subtype_new(type, args, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002543 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytes", kwlist, &x,
2544 &encoding, &errors))
2545 return NULL;
2546 if (x == NULL) {
2547 if (encoding != NULL || errors != NULL) {
2548 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka2c2044e2018-10-21 15:29:12 +03002549 encoding != NULL ?
2550 "encoding without a string argument" :
2551 "errors without a string argument");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002552 return NULL;
2553 }
Victor Stinnerdb067af2014-05-02 22:31:14 +02002554 return PyBytes_FromStringAndSize(NULL, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002555 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002556
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002557 if (encoding != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 /* Encode via the codec registry */
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002559 if (!PyUnicode_Check(x)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002561 "encoding without a string argument");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002562 return NULL;
2563 }
2564 new = PyUnicode_AsEncodedString(x, encoding, errors);
2565 if (new == NULL)
2566 return NULL;
2567 assert(PyBytes_Check(new));
2568 return new;
2569 }
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002570
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002571 if (errors != NULL) {
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +02002572 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002573 PyUnicode_Check(x) ?
2574 "string argument without an encoding" :
2575 "errors without a string argument");
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +02002576 return NULL;
2577 }
2578
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002579 /* We'd like to call PyObject_Bytes here, but we need to check for an
2580 integer argument before deferring to PyBytes_FromObject, something
2581 PyObject_Bytes doesn't do. */
2582 func = _PyObject_LookupSpecial(x, &PyId___bytes__);
2583 if (func != NULL) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01002584 new = _PyObject_CallNoArg(func);
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002585 Py_DECREF(func);
2586 if (new == NULL)
2587 return NULL;
2588 if (!PyBytes_Check(new)) {
2589 PyErr_Format(PyExc_TypeError,
2590 "__bytes__ returned non-bytes (type %.200s)",
2591 Py_TYPE(new)->tp_name);
2592 Py_DECREF(new);
2593 return NULL;
2594 }
2595 return new;
2596 }
2597 else if (PyErr_Occurred())
2598 return NULL;
2599
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002600 if (PyUnicode_Check(x)) {
2601 PyErr_SetString(PyExc_TypeError,
2602 "string argument without an encoding");
2603 return NULL;
2604 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002605 /* Is it an integer? */
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002606 if (PyIndex_Check(x)) {
2607 size = PyNumber_AsSsize_t(x, PyExc_OverflowError);
2608 if (size == -1 && PyErr_Occurred()) {
Serhiy Storchakae8904212018-10-15 00:02:57 +03002609 if (!PyErr_ExceptionMatches(PyExc_TypeError))
INADA Naokia634e232017-01-06 17:32:01 +09002610 return NULL;
2611 PyErr_Clear(); /* fall through */
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002612 }
INADA Naokia634e232017-01-06 17:32:01 +09002613 else {
2614 if (size < 0) {
2615 PyErr_SetString(PyExc_ValueError, "negative count");
2616 return NULL;
2617 }
2618 new = _PyBytes_FromSize(size, 1);
2619 if (new == NULL)
2620 return NULL;
2621 return new;
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002622 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002623 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002624
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002625 return PyBytes_FromObject(x);
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002626}
2627
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002628static PyObject*
2629_PyBytes_FromBuffer(PyObject *x)
2630{
2631 PyObject *new;
2632 Py_buffer view;
2633
2634 if (PyObject_GetBuffer(x, &view, PyBUF_FULL_RO) < 0)
2635 return NULL;
2636
2637 new = PyBytes_FromStringAndSize(NULL, view.len);
2638 if (!new)
2639 goto fail;
2640 if (PyBuffer_ToContiguous(((PyBytesObject *)new)->ob_sval,
2641 &view, view.len, 'C') < 0)
2642 goto fail;
2643 PyBuffer_Release(&view);
2644 return new;
2645
2646fail:
2647 Py_XDECREF(new);
2648 PyBuffer_Release(&view);
2649 return NULL;
2650}
2651
2652static PyObject*
2653_PyBytes_FromList(PyObject *x)
2654{
Serhiy Storchaka914f9a02018-10-21 15:25:53 +03002655 Py_ssize_t i, size = PyList_GET_SIZE(x);
2656 Py_ssize_t value;
2657 char *str;
2658 PyObject *item;
2659 _PyBytesWriter writer;
2660
2661 _PyBytesWriter_Init(&writer);
2662 str = _PyBytesWriter_Alloc(&writer, size);
2663 if (str == NULL)
2664 return NULL;
2665 writer.overallocate = 1;
2666 size = writer.allocated;
2667
2668 for (i = 0; i < PyList_GET_SIZE(x); i++) {
2669 item = PyList_GET_ITEM(x, i);
2670 Py_INCREF(item);
2671 value = PyNumber_AsSsize_t(item, NULL);
2672 Py_DECREF(item);
2673 if (value == -1 && PyErr_Occurred())
2674 goto error;
2675
2676 if (value < 0 || value >= 256) {
2677 PyErr_SetString(PyExc_ValueError,
2678 "bytes must be in range(0, 256)");
2679 goto error;
2680 }
2681
2682 if (i >= size) {
2683 str = _PyBytesWriter_Resize(&writer, str, size+1);
2684 if (str == NULL)
2685 return NULL;
2686 size = writer.allocated;
2687 }
2688 *str++ = (char) value;
2689 }
2690 return _PyBytesWriter_Finish(&writer, str);
2691
2692 error:
2693 _PyBytesWriter_Dealloc(&writer);
2694 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002695}
2696
2697static PyObject*
2698_PyBytes_FromTuple(PyObject *x)
2699{
Serhiy Storchaka914f9a02018-10-21 15:25:53 +03002700 PyObject *bytes;
2701 Py_ssize_t i, size = PyTuple_GET_SIZE(x);
2702 Py_ssize_t value;
2703 char *str;
2704 PyObject *item;
2705
2706 bytes = PyBytes_FromStringAndSize(NULL, size);
2707 if (bytes == NULL)
2708 return NULL;
2709 str = ((PyBytesObject *)bytes)->ob_sval;
2710
2711 for (i = 0; i < size; i++) {
2712 item = PyTuple_GET_ITEM(x, i);
2713 value = PyNumber_AsSsize_t(item, NULL);
2714 if (value == -1 && PyErr_Occurred())
2715 goto error;
2716
2717 if (value < 0 || value >= 256) {
2718 PyErr_SetString(PyExc_ValueError,
2719 "bytes must be in range(0, 256)");
2720 goto error;
2721 }
2722 *str++ = (char) value;
2723 }
2724 return bytes;
2725
2726 error:
2727 Py_DECREF(bytes);
2728 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002729}
2730
2731static PyObject *
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002732_PyBytes_FromIterator(PyObject *it, PyObject *x)
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002733{
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002734 char *str;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002735 Py_ssize_t i, size;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002736 _PyBytesWriter writer;
2737
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 /* For iterator version, create a string object and resize as needed */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02002739 size = PyObject_LengthHint(x, 64);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002740 if (size == -1 && PyErr_Occurred())
2741 return NULL;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002742
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002743 _PyBytesWriter_Init(&writer);
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002744 str = _PyBytesWriter_Alloc(&writer, size);
2745 if (str == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002746 return NULL;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002747 writer.overallocate = 1;
2748 size = writer.allocated;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002749
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002750 /* Run the iterator to exhaustion */
2751 for (i = 0; ; i++) {
2752 PyObject *item;
2753 Py_ssize_t value;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002754
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002755 /* Get the next item */
2756 item = PyIter_Next(it);
2757 if (item == NULL) {
2758 if (PyErr_Occurred())
2759 goto error;
2760 break;
2761 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002762
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 /* Interpret it as an int (__index__) */
Serhiy Storchakaf54d7812016-07-06 21:39:44 +03002764 value = PyNumber_AsSsize_t(item, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002765 Py_DECREF(item);
2766 if (value == -1 && PyErr_Occurred())
2767 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002768
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002769 /* Range check */
2770 if (value < 0 || value >= 256) {
2771 PyErr_SetString(PyExc_ValueError,
2772 "bytes must be in range(0, 256)");
2773 goto error;
2774 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002775
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002776 /* Append the byte */
2777 if (i >= size) {
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002778 str = _PyBytesWriter_Resize(&writer, str, size+1);
2779 if (str == NULL)
2780 return NULL;
2781 size = writer.allocated;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 }
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002783 *str++ = (char) value;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002784 }
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002785
2786 return _PyBytesWriter_Finish(&writer, str);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002787
2788 error:
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002789 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002790 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002791}
2792
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002793PyObject *
2794PyBytes_FromObject(PyObject *x)
2795{
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002796 PyObject *it, *result;
2797
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002798 if (x == NULL) {
2799 PyErr_BadInternalCall();
2800 return NULL;
2801 }
2802
2803 if (PyBytes_CheckExact(x)) {
2804 Py_INCREF(x);
2805 return x;
2806 }
2807
2808 /* Use the modern buffer interface */
2809 if (PyObject_CheckBuffer(x))
2810 return _PyBytes_FromBuffer(x);
2811
2812 if (PyList_CheckExact(x))
2813 return _PyBytes_FromList(x);
2814
2815 if (PyTuple_CheckExact(x))
2816 return _PyBytes_FromTuple(x);
2817
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002818 if (!PyUnicode_Check(x)) {
2819 it = PyObject_GetIter(x);
2820 if (it != NULL) {
2821 result = _PyBytes_FromIterator(it, x);
2822 Py_DECREF(it);
2823 return result;
2824 }
Serhiy Storchakae8904212018-10-15 00:02:57 +03002825 if (!PyErr_ExceptionMatches(PyExc_TypeError)) {
2826 return NULL;
2827 }
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002828 }
2829
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002830 PyErr_Format(PyExc_TypeError,
2831 "cannot convert '%.200s' object to bytes",
2832 x->ob_type->tp_name);
2833 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002834}
2835
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002836static PyObject *
Serhiy Storchaka15095802015-11-25 15:47:01 +02002837bytes_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002838{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002839 PyObject *tmp, *pnew;
2840 Py_ssize_t n;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002841
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002842 assert(PyType_IsSubtype(type, &PyBytes_Type));
2843 tmp = bytes_new(&PyBytes_Type, args, kwds);
2844 if (tmp == NULL)
2845 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02002846 assert(PyBytes_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002847 n = PyBytes_GET_SIZE(tmp);
2848 pnew = type->tp_alloc(type, n);
2849 if (pnew != NULL) {
Christian Heimesf051e432016-09-13 20:22:02 +02002850 memcpy(PyBytes_AS_STRING(pnew),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002851 PyBytes_AS_STRING(tmp), n+1);
2852 ((PyBytesObject *)pnew)->ob_shash =
2853 ((PyBytesObject *)tmp)->ob_shash;
2854 }
2855 Py_DECREF(tmp);
2856 return pnew;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002857}
2858
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002859PyDoc_STRVAR(bytes_doc,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002860"bytes(iterable_of_ints) -> bytes\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002861bytes(string, encoding[, errors]) -> bytes\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00002862bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer\n\
Victor Stinnerbb2e9c42011-12-17 23:18:07 +01002863bytes(int) -> bytes object of size given by the parameter initialized with null bytes\n\
2864bytes() -> empty bytes object\n\
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002865\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002866Construct an immutable array of bytes from:\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002867 - an iterable yielding integers in range(256)\n\
2868 - a text string encoded using the specified encoding\n\
Victor Stinnerbb2e9c42011-12-17 23:18:07 +01002869 - any object implementing the buffer API.\n\
2870 - an integer");
Guido van Rossum98297ee2007-11-06 21:34:58 +00002871
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002872static PyObject *bytes_iter(PyObject *seq);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002873
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002874PyTypeObject PyBytes_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002875 PyVarObject_HEAD_INIT(&PyType_Type, 0)
2876 "bytes",
2877 PyBytesObject_SIZE,
2878 sizeof(char),
2879 bytes_dealloc, /* tp_dealloc */
2880 0, /* tp_print */
2881 0, /* tp_getattr */
2882 0, /* tp_setattr */
2883 0, /* tp_reserved */
2884 (reprfunc)bytes_repr, /* tp_repr */
Ethan Furmanb95b5612015-01-23 20:05:18 -08002885 &bytes_as_number, /* tp_as_number */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002886 &bytes_as_sequence, /* tp_as_sequence */
2887 &bytes_as_mapping, /* tp_as_mapping */
2888 (hashfunc)bytes_hash, /* tp_hash */
2889 0, /* tp_call */
2890 bytes_str, /* tp_str */
2891 PyObject_GenericGetAttr, /* tp_getattro */
2892 0, /* tp_setattro */
2893 &bytes_as_buffer, /* tp_as_buffer */
2894 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
2895 Py_TPFLAGS_BYTES_SUBCLASS, /* tp_flags */
2896 bytes_doc, /* tp_doc */
2897 0, /* tp_traverse */
2898 0, /* tp_clear */
2899 (richcmpfunc)bytes_richcompare, /* tp_richcompare */
2900 0, /* tp_weaklistoffset */
2901 bytes_iter, /* tp_iter */
2902 0, /* tp_iternext */
2903 bytes_methods, /* tp_methods */
2904 0, /* tp_members */
2905 0, /* tp_getset */
2906 &PyBaseObject_Type, /* tp_base */
2907 0, /* tp_dict */
2908 0, /* tp_descr_get */
2909 0, /* tp_descr_set */
2910 0, /* tp_dictoffset */
2911 0, /* tp_init */
2912 0, /* tp_alloc */
2913 bytes_new, /* tp_new */
2914 PyObject_Del, /* tp_free */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002915};
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002916
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002917void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002918PyBytes_Concat(PyObject **pv, PyObject *w)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002919{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002920 assert(pv != NULL);
2921 if (*pv == NULL)
2922 return;
2923 if (w == NULL) {
Serhiy Storchakaf458a032013-02-02 18:45:22 +02002924 Py_CLEAR(*pv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002925 return;
2926 }
Antoine Pitrou161d6952014-05-01 14:36:20 +02002927
2928 if (Py_REFCNT(*pv) == 1 && PyBytes_CheckExact(*pv)) {
2929 /* Only one reference, so we can resize in place */
Zachary Warebca96942014-05-06 11:42:37 -05002930 Py_ssize_t oldsize;
Antoine Pitrou161d6952014-05-01 14:36:20 +02002931 Py_buffer wb;
Victor Stinner049e5092014-08-17 22:20:00 +02002932
Antoine Pitrou161d6952014-05-01 14:36:20 +02002933 wb.len = -1;
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002934 if (PyObject_GetBuffer(w, &wb, PyBUF_SIMPLE) != 0) {
Antoine Pitrou161d6952014-05-01 14:36:20 +02002935 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
2936 Py_TYPE(w)->tp_name, Py_TYPE(*pv)->tp_name);
2937 Py_CLEAR(*pv);
2938 return;
2939 }
2940
2941 oldsize = PyBytes_GET_SIZE(*pv);
2942 if (oldsize > PY_SSIZE_T_MAX - wb.len) {
2943 PyErr_NoMemory();
2944 goto error;
2945 }
2946 if (_PyBytes_Resize(pv, oldsize + wb.len) < 0)
2947 goto error;
2948
2949 memcpy(PyBytes_AS_STRING(*pv) + oldsize, wb.buf, wb.len);
2950 PyBuffer_Release(&wb);
2951 return;
2952
2953 error:
2954 PyBuffer_Release(&wb);
2955 Py_CLEAR(*pv);
2956 return;
2957 }
2958
2959 else {
2960 /* Multiple references, need to create new object */
2961 PyObject *v;
2962 v = bytes_concat(*pv, w);
Serhiy Storchaka57a01d32016-04-10 18:05:40 +03002963 Py_SETREF(*pv, v);
Antoine Pitrou161d6952014-05-01 14:36:20 +02002964 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002965}
2966
2967void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002968PyBytes_ConcatAndDel(PyObject **pv, PyObject *w)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002969{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002970 PyBytes_Concat(pv, w);
2971 Py_XDECREF(w);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002972}
2973
2974
Ethan Furmanb95b5612015-01-23 20:05:18 -08002975/* The following function breaks the notion that bytes are immutable:
2976 it changes the size of a bytes object. We get away with this only if there
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002977 is only one module referencing the object. You can also think of it
Ethan Furmanb95b5612015-01-23 20:05:18 -08002978 as creating a new bytes object and destroying the old one, only
2979 more efficiently. In any case, don't use this if the bytes object may
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002980 already be known to some other part of the code...
Ethan Furmanb95b5612015-01-23 20:05:18 -08002981 Note that if there's not enough memory to resize the bytes object, the
2982 original bytes object at *pv is deallocated, *pv is set to NULL, an "out of
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002983 memory" exception is set, and -1 is returned. Else (on success) 0 is
2984 returned, and the value in *pv may or may not be the same as on input.
2985 As always, an extra byte is allocated for a trailing \0 byte (newsize
2986 does *not* include that), and a trailing \0 byte is stored.
2987*/
2988
2989int
2990_PyBytes_Resize(PyObject **pv, Py_ssize_t newsize)
2991{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002992 PyObject *v;
2993 PyBytesObject *sv;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002994 v = *pv;
Berker Peksag4a72a7b2016-09-16 17:31:06 +03002995 if (!PyBytes_Check(v) || newsize < 0) {
2996 goto error;
2997 }
2998 if (Py_SIZE(v) == newsize) {
2999 /* return early if newsize equals to v->ob_size */
3000 return 0;
3001 }
Serhiy Storchaka44cc4822019-01-12 09:22:29 +02003002 if (Py_SIZE(v) == 0) {
3003 if (newsize == 0) {
3004 return 0;
3005 }
3006 *pv = _PyBytes_FromSize(newsize, 0);
3007 Py_DECREF(v);
3008 return (*pv == NULL) ? -1 : 0;
3009 }
Berker Peksag4a72a7b2016-09-16 17:31:06 +03003010 if (Py_REFCNT(v) != 1) {
3011 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003012 }
Serhiy Storchaka44cc4822019-01-12 09:22:29 +02003013 if (newsize == 0) {
3014 *pv = _PyBytes_FromSize(0, 0);
3015 Py_DECREF(v);
3016 return (*pv == NULL) ? -1 : 0;
3017 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003018 /* XXX UNREF/NEWREF interface should be more symmetrical */
3019 _Py_DEC_REFTOTAL;
3020 _Py_ForgetReference(v);
3021 *pv = (PyObject *)
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03003022 PyObject_REALLOC(v, PyBytesObject_SIZE + newsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003023 if (*pv == NULL) {
3024 PyObject_Del(v);
3025 PyErr_NoMemory();
3026 return -1;
3027 }
3028 _Py_NewReference(*pv);
3029 sv = (PyBytesObject *) *pv;
3030 Py_SIZE(sv) = newsize;
3031 sv->ob_sval[newsize] = '\0';
3032 sv->ob_shash = -1; /* invalidate cached hash value */
3033 return 0;
Berker Peksag4a72a7b2016-09-16 17:31:06 +03003034error:
3035 *pv = 0;
3036 Py_DECREF(v);
3037 PyErr_BadInternalCall();
3038 return -1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003039}
3040
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003041void
3042PyBytes_Fini(void)
3043{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003044 int i;
Serhiy Storchakaf458a032013-02-02 18:45:22 +02003045 for (i = 0; i < UCHAR_MAX + 1; i++)
3046 Py_CLEAR(characters[i]);
3047 Py_CLEAR(nullstring);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003048}
3049
Benjamin Peterson4116f362008-05-27 00:36:20 +00003050/*********************** Bytes Iterator ****************************/
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003051
3052typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003053 PyObject_HEAD
3054 Py_ssize_t it_index;
3055 PyBytesObject *it_seq; /* Set to NULL when iterator is exhausted */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003056} striterobject;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003057
3058static void
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003059striter_dealloc(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003060{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003061 _PyObject_GC_UNTRACK(it);
3062 Py_XDECREF(it->it_seq);
3063 PyObject_GC_Del(it);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003064}
3065
3066static int
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003067striter_traverse(striterobject *it, visitproc visit, void *arg)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003068{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003069 Py_VISIT(it->it_seq);
3070 return 0;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003071}
3072
3073static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003074striter_next(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003075{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003076 PyBytesObject *seq;
3077 PyObject *item;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003078
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003079 assert(it != NULL);
3080 seq = it->it_seq;
3081 if (seq == NULL)
3082 return NULL;
3083 assert(PyBytes_Check(seq));
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003084
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003085 if (it->it_index < PyBytes_GET_SIZE(seq)) {
3086 item = PyLong_FromLong(
3087 (unsigned char)seq->ob_sval[it->it_index]);
3088 if (item != NULL)
3089 ++it->it_index;
3090 return item;
3091 }
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003092
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 it->it_seq = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +03003094 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003095 return NULL;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003096}
3097
3098static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303099striter_len(striterobject *it, PyObject *Py_UNUSED(ignored))
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003100{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003101 Py_ssize_t len = 0;
3102 if (it->it_seq)
3103 len = PyBytes_GET_SIZE(it->it_seq) - it->it_index;
3104 return PyLong_FromSsize_t(len);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003105}
3106
3107PyDoc_STRVAR(length_hint_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003108 "Private method returning an estimate of len(list(it)).");
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003109
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003110static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303111striter_reduce(striterobject *it, PyObject *Py_UNUSED(ignored))
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003112{
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02003113 _Py_IDENTIFIER(iter);
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003114 if (it->it_seq != NULL) {
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02003115 return Py_BuildValue("N(O)n", _PyEval_GetBuiltinId(&PyId_iter),
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003116 it->it_seq, it->it_index);
3117 } else {
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02003118 return Py_BuildValue("N(())", _PyEval_GetBuiltinId(&PyId_iter));
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003119 }
3120}
3121
3122PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
3123
3124static PyObject *
3125striter_setstate(striterobject *it, PyObject *state)
3126{
3127 Py_ssize_t index = PyLong_AsSsize_t(state);
3128 if (index == -1 && PyErr_Occurred())
3129 return NULL;
Kristján Valur Jónsson25dded02014-03-05 13:47:57 +00003130 if (it->it_seq != NULL) {
3131 if (index < 0)
3132 index = 0;
3133 else if (index > PyBytes_GET_SIZE(it->it_seq))
3134 index = PyBytes_GET_SIZE(it->it_seq); /* iterator exhausted */
3135 it->it_index = index;
3136 }
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003137 Py_RETURN_NONE;
3138}
3139
3140PyDoc_STRVAR(setstate_doc, "Set state information for unpickling.");
3141
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003142static PyMethodDef striter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003143 {"__length_hint__", (PyCFunction)striter_len, METH_NOARGS,
3144 length_hint_doc},
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003145 {"__reduce__", (PyCFunction)striter_reduce, METH_NOARGS,
3146 reduce_doc},
3147 {"__setstate__", (PyCFunction)striter_setstate, METH_O,
3148 setstate_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003149 {NULL, NULL} /* sentinel */
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003150};
3151
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003152PyTypeObject PyBytesIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003153 PyVarObject_HEAD_INIT(&PyType_Type, 0)
3154 "bytes_iterator", /* tp_name */
3155 sizeof(striterobject), /* tp_basicsize */
3156 0, /* tp_itemsize */
3157 /* methods */
3158 (destructor)striter_dealloc, /* tp_dealloc */
3159 0, /* tp_print */
3160 0, /* tp_getattr */
3161 0, /* tp_setattr */
3162 0, /* tp_reserved */
3163 0, /* tp_repr */
3164 0, /* tp_as_number */
3165 0, /* tp_as_sequence */
3166 0, /* tp_as_mapping */
3167 0, /* tp_hash */
3168 0, /* tp_call */
3169 0, /* tp_str */
3170 PyObject_GenericGetAttr, /* tp_getattro */
3171 0, /* tp_setattro */
3172 0, /* tp_as_buffer */
3173 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
3174 0, /* tp_doc */
3175 (traverseproc)striter_traverse, /* tp_traverse */
3176 0, /* tp_clear */
3177 0, /* tp_richcompare */
3178 0, /* tp_weaklistoffset */
3179 PyObject_SelfIter, /* tp_iter */
3180 (iternextfunc)striter_next, /* tp_iternext */
3181 striter_methods, /* tp_methods */
3182 0,
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003183};
3184
3185static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003186bytes_iter(PyObject *seq)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003187{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 striterobject *it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003189
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003190 if (!PyBytes_Check(seq)) {
3191 PyErr_BadInternalCall();
3192 return NULL;
3193 }
3194 it = PyObject_GC_New(striterobject, &PyBytesIter_Type);
3195 if (it == NULL)
3196 return NULL;
3197 it->it_index = 0;
3198 Py_INCREF(seq);
3199 it->it_seq = (PyBytesObject *)seq;
3200 _PyObject_GC_TRACK(it);
3201 return (PyObject *)it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003202}
Victor Stinner00165072015-10-09 01:53:21 +02003203
3204
3205/* _PyBytesWriter API */
3206
3207#ifdef MS_WINDOWS
3208 /* On Windows, overallocate by 50% is the best factor */
3209# define OVERALLOCATE_FACTOR 2
3210#else
3211 /* On Linux, overallocate by 25% is the best factor */
3212# define OVERALLOCATE_FACTOR 4
3213#endif
3214
3215void
3216_PyBytesWriter_Init(_PyBytesWriter *writer)
3217{
Victor Stinner661aacc2015-10-14 09:41:48 +02003218 /* Set all attributes before small_buffer to 0 */
3219 memset(writer, 0, offsetof(_PyBytesWriter, small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003220#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003221 memset(writer->small_buffer, 0xCB, sizeof(writer->small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003222#endif
3223}
3224
3225void
3226_PyBytesWriter_Dealloc(_PyBytesWriter *writer)
3227{
3228 Py_CLEAR(writer->buffer);
3229}
3230
3231Py_LOCAL_INLINE(char*)
3232_PyBytesWriter_AsString(_PyBytesWriter *writer)
3233{
Victor Stinner661aacc2015-10-14 09:41:48 +02003234 if (writer->use_small_buffer) {
Victor Stinner00165072015-10-09 01:53:21 +02003235 assert(writer->buffer == NULL);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003236 return writer->small_buffer;
Victor Stinner00165072015-10-09 01:53:21 +02003237 }
Victor Stinner661aacc2015-10-14 09:41:48 +02003238 else if (writer->use_bytearray) {
3239 assert(writer->buffer != NULL);
3240 return PyByteArray_AS_STRING(writer->buffer);
3241 }
3242 else {
3243 assert(writer->buffer != NULL);
3244 return PyBytes_AS_STRING(writer->buffer);
3245 }
Victor Stinner00165072015-10-09 01:53:21 +02003246}
3247
3248Py_LOCAL_INLINE(Py_ssize_t)
Victor Stinner2bf89932015-10-14 11:25:33 +02003249_PyBytesWriter_GetSize(_PyBytesWriter *writer, char *str)
Victor Stinner00165072015-10-09 01:53:21 +02003250{
3251 char *start = _PyBytesWriter_AsString(writer);
3252 assert(str != NULL);
3253 assert(str >= start);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003254 assert(str - start <= writer->allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003255 return str - start;
3256}
3257
3258Py_LOCAL_INLINE(void)
3259_PyBytesWriter_CheckConsistency(_PyBytesWriter *writer, char *str)
3260{
3261#ifdef Py_DEBUG
3262 char *start, *end;
3263
Victor Stinner661aacc2015-10-14 09:41:48 +02003264 if (writer->use_small_buffer) {
Victor Stinner00165072015-10-09 01:53:21 +02003265 assert(writer->buffer == NULL);
3266 }
Victor Stinner661aacc2015-10-14 09:41:48 +02003267 else {
3268 assert(writer->buffer != NULL);
3269 if (writer->use_bytearray)
3270 assert(PyByteArray_CheckExact(writer->buffer));
3271 else
3272 assert(PyBytes_CheckExact(writer->buffer));
3273 assert(Py_REFCNT(writer->buffer) == 1);
3274 }
Victor Stinner00165072015-10-09 01:53:21 +02003275
Victor Stinner661aacc2015-10-14 09:41:48 +02003276 if (writer->use_bytearray) {
3277 /* bytearray has its own overallocation algorithm,
3278 writer overallocation must be disabled */
3279 assert(!writer->overallocate);
3280 }
3281
3282 assert(0 <= writer->allocated);
Victor Stinner53926a12015-10-09 12:37:03 +02003283 assert(0 <= writer->min_size && writer->min_size <= writer->allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003284 /* the last byte must always be null */
Victor Stinner661aacc2015-10-14 09:41:48 +02003285 start = _PyBytesWriter_AsString(writer);
Victor Stinner00165072015-10-09 01:53:21 +02003286 assert(start[writer->allocated] == 0);
3287
3288 end = start + writer->allocated;
3289 assert(str != NULL);
3290 assert(start <= str && str <= end);
3291#endif
3292}
3293
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003294void*
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003295_PyBytesWriter_Resize(_PyBytesWriter *writer, void *str, Py_ssize_t size)
Victor Stinner00165072015-10-09 01:53:21 +02003296{
3297 Py_ssize_t allocated, pos;
3298
3299 _PyBytesWriter_CheckConsistency(writer, str);
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003300 assert(writer->allocated < size);
Victor Stinner00165072015-10-09 01:53:21 +02003301
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003302 allocated = size;
Victor Stinner00165072015-10-09 01:53:21 +02003303 if (writer->overallocate
3304 && allocated <= (PY_SSIZE_T_MAX - allocated / OVERALLOCATE_FACTOR)) {
3305 /* overallocate to limit the number of realloc() */
3306 allocated += allocated / OVERALLOCATE_FACTOR;
3307 }
3308
Victor Stinner2bf89932015-10-14 11:25:33 +02003309 pos = _PyBytesWriter_GetSize(writer, str);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003310 if (!writer->use_small_buffer) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003311 if (writer->use_bytearray) {
3312 if (PyByteArray_Resize(writer->buffer, allocated))
3313 goto error;
3314 /* writer->allocated can be smaller than writer->buffer->ob_alloc,
3315 but we cannot use ob_alloc because bytes may need to be moved
3316 to use the whole buffer. bytearray uses an internal optimization
3317 to avoid moving or copying bytes when bytes are removed at the
3318 beginning (ex: del bytearray[:1]). */
3319 }
3320 else {
3321 if (_PyBytes_Resize(&writer->buffer, allocated))
3322 goto error;
Victor Stinner00165072015-10-09 01:53:21 +02003323 }
3324 }
3325 else {
3326 /* convert from stack buffer to bytes object buffer */
3327 assert(writer->buffer == NULL);
3328
Victor Stinner661aacc2015-10-14 09:41:48 +02003329 if (writer->use_bytearray)
3330 writer->buffer = PyByteArray_FromStringAndSize(NULL, allocated);
3331 else
3332 writer->buffer = PyBytes_FromStringAndSize(NULL, allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003333 if (writer->buffer == NULL)
Victor Stinner661aacc2015-10-14 09:41:48 +02003334 goto error;
Victor Stinner00165072015-10-09 01:53:21 +02003335
3336 if (pos != 0) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003337 char *dest;
3338 if (writer->use_bytearray)
3339 dest = PyByteArray_AS_STRING(writer->buffer);
3340 else
3341 dest = PyBytes_AS_STRING(writer->buffer);
Christian Heimesf051e432016-09-13 20:22:02 +02003342 memcpy(dest,
Victor Stinnerb3653a32015-10-09 03:38:24 +02003343 writer->small_buffer,
Victor Stinner00165072015-10-09 01:53:21 +02003344 pos);
3345 }
3346
Victor Stinnerb3653a32015-10-09 03:38:24 +02003347 writer->use_small_buffer = 0;
Victor Stinner00165072015-10-09 01:53:21 +02003348#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003349 memset(writer->small_buffer, 0xDB, sizeof(writer->small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003350#endif
Victor Stinner00165072015-10-09 01:53:21 +02003351 }
3352 writer->allocated = allocated;
3353
3354 str = _PyBytesWriter_AsString(writer) + pos;
3355 _PyBytesWriter_CheckConsistency(writer, str);
3356 return str;
Victor Stinner661aacc2015-10-14 09:41:48 +02003357
3358error:
3359 _PyBytesWriter_Dealloc(writer);
3360 return NULL;
Victor Stinner00165072015-10-09 01:53:21 +02003361}
3362
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003363void*
3364_PyBytesWriter_Prepare(_PyBytesWriter *writer, void *str, Py_ssize_t size)
3365{
3366 Py_ssize_t new_min_size;
3367
3368 _PyBytesWriter_CheckConsistency(writer, str);
3369 assert(size >= 0);
3370
3371 if (size == 0) {
3372 /* nothing to do */
3373 return str;
3374 }
3375
3376 if (writer->min_size > PY_SSIZE_T_MAX - size) {
3377 PyErr_NoMemory();
3378 _PyBytesWriter_Dealloc(writer);
3379 return NULL;
3380 }
3381 new_min_size = writer->min_size + size;
3382
3383 if (new_min_size > writer->allocated)
3384 str = _PyBytesWriter_Resize(writer, str, new_min_size);
3385
3386 writer->min_size = new_min_size;
3387 return str;
3388}
3389
Victor Stinner00165072015-10-09 01:53:21 +02003390/* Allocate the buffer to write size bytes.
3391 Return the pointer to the beginning of buffer data.
3392 Raise an exception and return NULL on error. */
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003393void*
Victor Stinner00165072015-10-09 01:53:21 +02003394_PyBytesWriter_Alloc(_PyBytesWriter *writer, Py_ssize_t size)
3395{
3396 /* ensure that _PyBytesWriter_Alloc() is only called once */
Victor Stinner53926a12015-10-09 12:37:03 +02003397 assert(writer->min_size == 0 && writer->buffer == NULL);
Victor Stinner00165072015-10-09 01:53:21 +02003398 assert(size >= 0);
3399
Victor Stinnerb3653a32015-10-09 03:38:24 +02003400 writer->use_small_buffer = 1;
Victor Stinnerb13b97d2015-10-09 02:52:16 +02003401#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003402 writer->allocated = sizeof(writer->small_buffer) - 1;
Victor Stinnerf6358a72015-10-14 12:02:39 +02003403 /* In debug mode, don't use the full small buffer because it is less
3404 efficient than bytes and bytearray objects to detect buffer underflow
3405 and buffer overflow. Use 10 bytes of the small buffer to test also
3406 code using the smaller buffer in debug mode.
3407
3408 Don't modify the _PyBytesWriter structure (use a shorter small buffer)
3409 in debug mode to also be able to detect stack overflow when running
3410 tests in debug mode. The _PyBytesWriter is large (more than 512 bytes),
3411 if Py_EnterRecursiveCall() is not used in deep C callback, we may hit a
3412 stack overflow. */
3413 writer->allocated = Py_MIN(writer->allocated, 10);
3414 /* _PyBytesWriter_CheckConsistency() requires the last byte to be 0,
3415 to detect buffer overflow */
Victor Stinnerb3653a32015-10-09 03:38:24 +02003416 writer->small_buffer[writer->allocated] = 0;
Victor Stinner00165072015-10-09 01:53:21 +02003417#else
Victor Stinnerb3653a32015-10-09 03:38:24 +02003418 writer->allocated = sizeof(writer->small_buffer);
Victor Stinner00165072015-10-09 01:53:21 +02003419#endif
Victor Stinnerb3653a32015-10-09 03:38:24 +02003420 return _PyBytesWriter_Prepare(writer, writer->small_buffer, size);
Victor Stinner00165072015-10-09 01:53:21 +02003421}
3422
3423PyObject *
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003424_PyBytesWriter_Finish(_PyBytesWriter *writer, void *str)
Victor Stinner00165072015-10-09 01:53:21 +02003425{
Victor Stinner2bf89932015-10-14 11:25:33 +02003426 Py_ssize_t size;
Victor Stinner00165072015-10-09 01:53:21 +02003427 PyObject *result;
3428
3429 _PyBytesWriter_CheckConsistency(writer, str);
3430
Victor Stinner2bf89932015-10-14 11:25:33 +02003431 size = _PyBytesWriter_GetSize(writer, str);
3432 if (size == 0 && !writer->use_bytearray) {
Victor Stinner6c2cdae2015-10-12 13:29:43 +02003433 Py_CLEAR(writer->buffer);
3434 /* Get the empty byte string singleton */
3435 result = PyBytes_FromStringAndSize(NULL, 0);
3436 }
3437 else if (writer->use_small_buffer) {
Victor Stinnere914d412016-04-15 17:52:27 +02003438 if (writer->use_bytearray) {
3439 result = PyByteArray_FromStringAndSize(writer->small_buffer, size);
3440 }
3441 else {
3442 result = PyBytes_FromStringAndSize(writer->small_buffer, size);
3443 }
Victor Stinner6c2cdae2015-10-12 13:29:43 +02003444 }
3445 else {
3446 result = writer->buffer;
3447 writer->buffer = NULL;
3448
Victor Stinner2bf89932015-10-14 11:25:33 +02003449 if (size != writer->allocated) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003450 if (writer->use_bytearray) {
Victor Stinner2bf89932015-10-14 11:25:33 +02003451 if (PyByteArray_Resize(result, size)) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003452 Py_DECREF(result);
3453 return NULL;
3454 }
3455 }
3456 else {
Victor Stinner2bf89932015-10-14 11:25:33 +02003457 if (_PyBytes_Resize(&result, size)) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003458 assert(result == NULL);
3459 return NULL;
3460 }
Victor Stinner00165072015-10-09 01:53:21 +02003461 }
3462 }
Victor Stinner00165072015-10-09 01:53:21 +02003463 }
Victor Stinner00165072015-10-09 01:53:21 +02003464 return result;
3465}
Victor Stinnerce179bf2015-10-09 12:57:22 +02003466
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003467void*
Victor Stinnere9aa5952015-10-12 13:57:47 +02003468_PyBytesWriter_WriteBytes(_PyBytesWriter *writer, void *ptr,
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003469 const void *bytes, Py_ssize_t size)
Victor Stinnerce179bf2015-10-09 12:57:22 +02003470{
Victor Stinnere9aa5952015-10-12 13:57:47 +02003471 char *str = (char *)ptr;
3472
Victor Stinnerce179bf2015-10-09 12:57:22 +02003473 str = _PyBytesWriter_Prepare(writer, str, size);
3474 if (str == NULL)
3475 return NULL;
3476
Christian Heimesf051e432016-09-13 20:22:02 +02003477 memcpy(str, bytes, size);
Victor Stinnerce179bf2015-10-09 12:57:22 +02003478 str += size;
3479
3480 return str;
3481}