blob: b299d4871702a40c3a7688bec96b3e911631c353 [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,
1213 "invalid \\x escape at position %d",
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{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001424 if (Py_BytesWarningFlag) {
1425 if (PyErr_WarnEx(PyExc_BytesWarning,
Victor Stinner53b7d4e2018-07-25 01:37:05 +02001426 "str() on a bytes instance", 1)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001427 return NULL;
Victor Stinner53b7d4e2018-07-25 01:37:05 +02001428 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001429 }
1430 return bytes_repr(op);
Neal Norwitz6968b052007-02-27 19:02:19 +00001431}
1432
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001433static Py_ssize_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001434bytes_length(PyBytesObject *a)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001435{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001436 return Py_SIZE(a);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001437}
Neal Norwitz6968b052007-02-27 19:02:19 +00001438
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001439/* This is also used by PyBytes_Concat() */
1440static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001441bytes_concat(PyObject *a, PyObject *b)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001442{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001443 Py_buffer va, vb;
1444 PyObject *result = NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001445
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001446 va.len = -1;
1447 vb.len = -1;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001448 if (PyObject_GetBuffer(a, &va, PyBUF_SIMPLE) != 0 ||
1449 PyObject_GetBuffer(b, &vb, PyBUF_SIMPLE) != 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001450 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
Serhiy Storchaka6b5a9ec2017-03-19 19:47:02 +02001451 Py_TYPE(b)->tp_name, Py_TYPE(a)->tp_name);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001452 goto done;
1453 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001454
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001455 /* Optimize end cases */
1456 if (va.len == 0 && PyBytes_CheckExact(b)) {
1457 result = b;
1458 Py_INCREF(result);
1459 goto done;
1460 }
1461 if (vb.len == 0 && PyBytes_CheckExact(a)) {
1462 result = a;
1463 Py_INCREF(result);
1464 goto done;
1465 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001466
Serhiy Storchaka06cfb0c2016-07-10 20:48:43 +03001467 if (va.len > PY_SSIZE_T_MAX - vb.len) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001468 PyErr_NoMemory();
1469 goto done;
1470 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001471
Serhiy Storchaka06cfb0c2016-07-10 20:48:43 +03001472 result = PyBytes_FromStringAndSize(NULL, va.len + vb.len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001473 if (result != NULL) {
1474 memcpy(PyBytes_AS_STRING(result), va.buf, va.len);
1475 memcpy(PyBytes_AS_STRING(result) + va.len, vb.buf, vb.len);
1476 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001477
1478 done:
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001479 if (va.len != -1)
1480 PyBuffer_Release(&va);
1481 if (vb.len != -1)
1482 PyBuffer_Release(&vb);
1483 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001484}
Neal Norwitz6968b052007-02-27 19:02:19 +00001485
1486static PyObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001487bytes_repeat(PyBytesObject *a, Py_ssize_t n)
Neal Norwitz6968b052007-02-27 19:02:19 +00001488{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001489 Py_ssize_t i;
1490 Py_ssize_t j;
1491 Py_ssize_t size;
1492 PyBytesObject *op;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001493 size_t nbytes;
1494 if (n < 0)
1495 n = 0;
1496 /* watch out for overflows: the size can overflow int,
1497 * and the # of bytes needed can overflow size_t
1498 */
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001499 if (n > 0 && Py_SIZE(a) > PY_SSIZE_T_MAX / n) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001500 PyErr_SetString(PyExc_OverflowError,
1501 "repeated bytes are too long");
1502 return NULL;
1503 }
Mark Dickinsoncf940c72010-08-10 18:35:01 +00001504 size = Py_SIZE(a) * n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001505 if (size == Py_SIZE(a) && PyBytes_CheckExact(a)) {
1506 Py_INCREF(a);
1507 return (PyObject *)a;
1508 }
1509 nbytes = (size_t)size;
1510 if (nbytes + PyBytesObject_SIZE <= nbytes) {
1511 PyErr_SetString(PyExc_OverflowError,
1512 "repeated bytes are too long");
1513 return NULL;
1514 }
1515 op = (PyBytesObject *)PyObject_MALLOC(PyBytesObject_SIZE + nbytes);
1516 if (op == NULL)
1517 return PyErr_NoMemory();
Victor Stinnerb509d522018-11-23 14:27:38 +01001518 (void)PyObject_INIT_VAR(op, &PyBytes_Type, size);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001519 op->ob_shash = -1;
1520 op->ob_sval[size] = '\0';
1521 if (Py_SIZE(a) == 1 && n > 0) {
1522 memset(op->ob_sval, a->ob_sval[0] , n);
1523 return (PyObject *) op;
1524 }
1525 i = 0;
1526 if (i < size) {
Christian Heimesf051e432016-09-13 20:22:02 +02001527 memcpy(op->ob_sval, a->ob_sval, Py_SIZE(a));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001528 i = Py_SIZE(a);
1529 }
1530 while (i < size) {
1531 j = (i <= size-i) ? i : size-i;
Christian Heimesf051e432016-09-13 20:22:02 +02001532 memcpy(op->ob_sval+i, op->ob_sval, j);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001533 i += j;
1534 }
1535 return (PyObject *) op;
Neal Norwitz6968b052007-02-27 19:02:19 +00001536}
1537
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001538static int
1539bytes_contains(PyObject *self, PyObject *arg)
1540{
1541 return _Py_bytes_contains(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), arg);
1542}
1543
Neal Norwitz6968b052007-02-27 19:02:19 +00001544static PyObject *
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02001545bytes_item(PyBytesObject *a, Py_ssize_t i)
Neal Norwitz6968b052007-02-27 19:02:19 +00001546{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001547 if (i < 0 || i >= Py_SIZE(a)) {
1548 PyErr_SetString(PyExc_IndexError, "index out of range");
1549 return NULL;
1550 }
1551 return PyLong_FromLong((unsigned char)a->ob_sval[i]);
Neal Norwitz6968b052007-02-27 19:02:19 +00001552}
1553
Benjamin Peterson621b4302016-09-09 13:54:34 -07001554static int
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001555bytes_compare_eq(PyBytesObject *a, PyBytesObject *b)
1556{
1557 int cmp;
1558 Py_ssize_t len;
1559
1560 len = Py_SIZE(a);
1561 if (Py_SIZE(b) != len)
1562 return 0;
1563
1564 if (a->ob_sval[0] != b->ob_sval[0])
1565 return 0;
1566
1567 cmp = memcmp(a->ob_sval, b->ob_sval, len);
1568 return (cmp == 0);
1569}
1570
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001571static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001572bytes_richcompare(PyBytesObject *a, PyBytesObject *b, int op)
Neal Norwitz6968b052007-02-27 19:02:19 +00001573{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001574 int c;
1575 Py_ssize_t len_a, len_b;
1576 Py_ssize_t min_len;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001577 int rc;
Neal Norwitz6968b052007-02-27 19:02:19 +00001578
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001579 /* Make sure both arguments are strings. */
1580 if (!(PyBytes_Check(a) && PyBytes_Check(b))) {
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001581 if (Py_BytesWarningFlag && (op == Py_EQ || op == Py_NE)) {
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001582 rc = PyObject_IsInstance((PyObject*)a,
1583 (PyObject*)&PyUnicode_Type);
1584 if (!rc)
1585 rc = PyObject_IsInstance((PyObject*)b,
1586 (PyObject*)&PyUnicode_Type);
1587 if (rc < 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001588 return NULL;
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001589 if (rc) {
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001590 if (PyErr_WarnEx(PyExc_BytesWarning,
Serhiy Storchakafa494fd2015-05-30 17:45:22 +03001591 "Comparison between bytes and string", 1))
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001592 return NULL;
1593 }
Serhiy Storchakaac5569b2015-05-30 17:48:19 +03001594 else {
1595 rc = PyObject_IsInstance((PyObject*)a,
1596 (PyObject*)&PyLong_Type);
1597 if (!rc)
1598 rc = PyObject_IsInstance((PyObject*)b,
1599 (PyObject*)&PyLong_Type);
1600 if (rc < 0)
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001601 return NULL;
Serhiy Storchakaac5569b2015-05-30 17:48:19 +03001602 if (rc) {
1603 if (PyErr_WarnEx(PyExc_BytesWarning,
1604 "Comparison between bytes and int", 1))
1605 return NULL;
1606 }
Serhiy Storchaka1dd49822015-03-20 16:54:57 +02001607 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001608 }
stratakise8b19652017-11-02 11:32:54 +01001609 Py_RETURN_NOTIMPLEMENTED;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001610 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001611 else if (a == b) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001612 switch (op) {
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001613 case Py_EQ:
1614 case Py_LE:
1615 case Py_GE:
1616 /* a string is equal to itself */
stratakise8b19652017-11-02 11:32:54 +01001617 Py_RETURN_TRUE;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001618 break;
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001619 case Py_NE:
1620 case Py_LT:
1621 case Py_GT:
stratakise8b19652017-11-02 11:32:54 +01001622 Py_RETURN_FALSE;
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001623 break;
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001624 default:
1625 PyErr_BadArgument();
1626 return NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001627 }
1628 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001629 else if (op == Py_EQ || op == Py_NE) {
1630 int eq = bytes_compare_eq(a, b);
1631 eq ^= (op == Py_NE);
stratakise8b19652017-11-02 11:32:54 +01001632 return PyBool_FromLong(eq);
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001633 }
1634 else {
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001635 len_a = Py_SIZE(a);
1636 len_b = Py_SIZE(b);
1637 min_len = Py_MIN(len_a, len_b);
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001638 if (min_len > 0) {
1639 c = Py_CHARMASK(*a->ob_sval) - Py_CHARMASK(*b->ob_sval);
Victor Stinnerfd9e44d2013-11-04 11:23:05 +01001640 if (c == 0)
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001641 c = memcmp(a->ob_sval, b->ob_sval, min_len);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001642 }
Victor Stinnerc8bc5372013-11-04 11:08:10 +01001643 else
1644 c = 0;
stratakise8b19652017-11-02 11:32:54 +01001645 if (c != 0)
1646 Py_RETURN_RICHCOMPARE(c, 0, op);
1647 Py_RETURN_RICHCOMPARE(len_a, len_b, op);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001648 }
Neal Norwitz6968b052007-02-27 19:02:19 +00001649}
1650
Benjamin Peterson8f67d082010-10-17 20:54:53 +00001651static Py_hash_t
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001652bytes_hash(PyBytesObject *a)
Neal Norwitz6968b052007-02-27 19:02:19 +00001653{
Antoine Pitrouce4a9da2011-11-21 20:46:33 +01001654 if (a->ob_shash == -1) {
1655 /* Can't fail */
Christian Heimes985ecdc2013-11-20 11:46:18 +01001656 a->ob_shash = _Py_HashBytes(a->ob_sval, Py_SIZE(a));
Antoine Pitrouce4a9da2011-11-21 20:46:33 +01001657 }
1658 return a->ob_shash;
Neal Norwitz6968b052007-02-27 19:02:19 +00001659}
1660
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001661static PyObject*
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001662bytes_subscript(PyBytesObject* self, PyObject* item)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001663{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001664 if (PyIndex_Check(item)) {
1665 Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);
1666 if (i == -1 && PyErr_Occurred())
1667 return NULL;
1668 if (i < 0)
1669 i += PyBytes_GET_SIZE(self);
1670 if (i < 0 || i >= PyBytes_GET_SIZE(self)) {
1671 PyErr_SetString(PyExc_IndexError,
1672 "index out of range");
1673 return NULL;
1674 }
1675 return PyLong_FromLong((unsigned char)self->ob_sval[i]);
1676 }
1677 else if (PySlice_Check(item)) {
1678 Py_ssize_t start, stop, step, slicelength, cur, i;
1679 char* source_buf;
1680 char* result_buf;
1681 PyObject* result;
Neal Norwitz6968b052007-02-27 19:02:19 +00001682
Serhiy Storchakab879fe82017-04-08 09:53:51 +03001683 if (PySlice_Unpack(item, &start, &stop, &step) < 0) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001684 return NULL;
1685 }
Serhiy Storchakab879fe82017-04-08 09:53:51 +03001686 slicelength = PySlice_AdjustIndices(PyBytes_GET_SIZE(self), &start,
1687 &stop, step);
Neal Norwitz6968b052007-02-27 19:02:19 +00001688
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001689 if (slicelength <= 0) {
1690 return PyBytes_FromStringAndSize("", 0);
1691 }
1692 else if (start == 0 && step == 1 &&
1693 slicelength == PyBytes_GET_SIZE(self) &&
1694 PyBytes_CheckExact(self)) {
1695 Py_INCREF(self);
1696 return (PyObject *)self;
1697 }
1698 else if (step == 1) {
1699 return PyBytes_FromStringAndSize(
1700 PyBytes_AS_STRING(self) + start,
1701 slicelength);
1702 }
1703 else {
1704 source_buf = PyBytes_AS_STRING(self);
1705 result = PyBytes_FromStringAndSize(NULL, slicelength);
1706 if (result == NULL)
1707 return NULL;
Neal Norwitz6968b052007-02-27 19:02:19 +00001708
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001709 result_buf = PyBytes_AS_STRING(result);
1710 for (cur = start, i = 0; i < slicelength;
1711 cur += step, i++) {
1712 result_buf[i] = source_buf[cur];
1713 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001714
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001715 return result;
1716 }
1717 }
1718 else {
1719 PyErr_Format(PyExc_TypeError,
Terry Jan Reedyffff1442014-08-02 01:30:37 -04001720 "byte indices must be integers or slices, not %.200s",
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001721 Py_TYPE(item)->tp_name);
1722 return NULL;
1723 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001724}
1725
1726static int
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001727bytes_buffer_getbuffer(PyBytesObject *self, Py_buffer *view, int flags)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001728{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001729 return PyBuffer_FillInfo(view, (PyObject*)self, (void *)self->ob_sval, Py_SIZE(self),
1730 1, flags);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001731}
1732
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001733static PySequenceMethods bytes_as_sequence = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001734 (lenfunc)bytes_length, /*sq_length*/
1735 (binaryfunc)bytes_concat, /*sq_concat*/
1736 (ssizeargfunc)bytes_repeat, /*sq_repeat*/
1737 (ssizeargfunc)bytes_item, /*sq_item*/
1738 0, /*sq_slice*/
1739 0, /*sq_ass_item*/
1740 0, /*sq_ass_slice*/
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001741 (objobjproc)bytes_contains /*sq_contains*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001742};
1743
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001744static PyMappingMethods bytes_as_mapping = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001745 (lenfunc)bytes_length,
1746 (binaryfunc)bytes_subscript,
1747 0,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001748};
1749
Benjamin Peterson80688ef2009-04-18 15:17:02 +00001750static PyBufferProcs bytes_as_buffer = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001751 (getbufferproc)bytes_buffer_getbuffer,
1752 NULL,
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001753};
1754
1755
1756#define LEFTSTRIP 0
1757#define RIGHTSTRIP 1
1758#define BOTHSTRIP 2
1759
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001760/*[clinic input]
1761bytes.split
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001762
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001763 sep: object = None
1764 The delimiter according which to split the bytes.
1765 None (the default value) means split on ASCII whitespace characters
1766 (space, tab, return, newline, formfeed, vertical tab).
1767 maxsplit: Py_ssize_t = -1
1768 Maximum number of splits to do.
1769 -1 (the default value) means no limit.
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001770
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001771Return a list of the sections in the bytes, using sep as the delimiter.
1772[clinic start generated code]*/
1773
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001774static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001775bytes_split_impl(PyBytesObject *self, PyObject *sep, Py_ssize_t maxsplit)
1776/*[clinic end generated code: output=52126b5844c1d8ef input=8b809b39074abbfa]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001777{
1778 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001779 const char *s = PyBytes_AS_STRING(self), *sub;
1780 Py_buffer vsub;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001781 PyObject *list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001782
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001783 if (maxsplit < 0)
1784 maxsplit = PY_SSIZE_T_MAX;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001785 if (sep == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001786 return stringlib_split_whitespace((PyObject*) self, s, len, maxsplit);
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001787 if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001788 return NULL;
1789 sub = vsub.buf;
1790 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001791
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001792 list = stringlib_split((PyObject*) self, s, len, sub, n, maxsplit);
1793 PyBuffer_Release(&vsub);
1794 return list;
Guido van Rossum98297ee2007-11-06 21:34:58 +00001795}
1796
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001797/*[clinic input]
1798bytes.partition
1799
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001800 sep: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001801 /
1802
1803Partition the bytes into three parts using the given separator.
1804
1805This will search for the separator sep in the bytes. If the separator is found,
1806returns a 3-tuple containing the part before the separator, the separator
1807itself, and the part after it.
1808
1809If the separator is not found, returns a 3-tuple containing the original bytes
1810object and two empty bytes objects.
1811[clinic start generated code]*/
1812
Neal Norwitz6968b052007-02-27 19:02:19 +00001813static PyObject *
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001814bytes_partition_impl(PyBytesObject *self, Py_buffer *sep)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001815/*[clinic end generated code: output=f532b392a17ff695 input=61cca95519406099]*/
Neal Norwitz6968b052007-02-27 19:02:19 +00001816{
Neal Norwitz6968b052007-02-27 19:02:19 +00001817 return stringlib_partition(
1818 (PyObject*) self,
1819 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001820 sep->obj, (const char *)sep->buf, sep->len
Neal Norwitz6968b052007-02-27 19:02:19 +00001821 );
1822}
1823
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001824/*[clinic input]
1825bytes.rpartition
1826
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001827 sep: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001828 /
1829
1830Partition the bytes into three parts using the given separator.
1831
Serhiy Storchakaa2314282017-10-29 02:11:54 +03001832This will search for the separator sep in the bytes, starting at the end. If
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001833the separator is found, returns a 3-tuple containing the part before the
1834separator, the separator itself, and the part after it.
1835
1836If the separator is not found, returns a 3-tuple containing two empty bytes
1837objects and the original bytes object.
1838[clinic start generated code]*/
1839
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001840static PyObject *
1841bytes_rpartition_impl(PyBytesObject *self, Py_buffer *sep)
Serhiy Storchakaa2314282017-10-29 02:11:54 +03001842/*[clinic end generated code: output=191b114cbb028e50 input=d78db010c8cfdbe1]*/
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001843{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001844 return stringlib_rpartition(
1845 (PyObject*) self,
1846 PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001847 sep->obj, (const char *)sep->buf, sep->len
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001848 );
Neal Norwitz6968b052007-02-27 19:02:19 +00001849}
1850
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001851/*[clinic input]
1852bytes.rsplit = bytes.split
Neal Norwitz6968b052007-02-27 19:02:19 +00001853
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001854Return a list of the sections in the bytes, using sep as the delimiter.
1855
1856Splitting is done starting at the end of the bytes and working to the front.
1857[clinic start generated code]*/
1858
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001859static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001860bytes_rsplit_impl(PyBytesObject *self, PyObject *sep, Py_ssize_t maxsplit)
1861/*[clinic end generated code: output=ba698d9ea01e1c8f input=0f86c9f28f7d7b7b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001862{
1863 Py_ssize_t len = PyBytes_GET_SIZE(self), n;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001864 const char *s = PyBytes_AS_STRING(self), *sub;
1865 Py_buffer vsub;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001866 PyObject *list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001867
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001868 if (maxsplit < 0)
1869 maxsplit = PY_SSIZE_T_MAX;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001870 if (sep == Py_None)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001871 return stringlib_rsplit_whitespace((PyObject*) self, s, len, maxsplit);
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02001872 if (PyObject_GetBuffer(sep, &vsub, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001873 return NULL;
1874 sub = vsub.buf;
1875 n = vsub.len;
Guido van Rossum8f950672007-09-10 16:53:45 +00001876
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001877 list = stringlib_rsplit((PyObject*) self, s, len, sub, n, maxsplit);
1878 PyBuffer_Release(&vsub);
1879 return list;
Neal Norwitz6968b052007-02-27 19:02:19 +00001880}
1881
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001882
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02001883/*[clinic input]
1884bytes.join
1885
1886 iterable_of_bytes: object
1887 /
1888
1889Concatenate any number of bytes objects.
1890
1891The bytes whose method is called is inserted in between each pair.
1892
1893The result is returned as a new bytes object.
1894
1895Example: b'.'.join([b'ab', b'pq', b'rs']) -> b'ab.pq.rs'.
1896[clinic start generated code]*/
1897
Neal Norwitz6968b052007-02-27 19:02:19 +00001898static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03001899bytes_join(PyBytesObject *self, PyObject *iterable_of_bytes)
1900/*[clinic end generated code: output=a046f379f626f6f8 input=7fe377b95bd549d2]*/
Neal Norwitz6968b052007-02-27 19:02:19 +00001901{
Martin v. Löwis0efea322014-07-27 17:29:17 +02001902 return stringlib_bytes_join((PyObject*)self, iterable_of_bytes);
Neal Norwitz6968b052007-02-27 19:02:19 +00001903}
1904
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001905PyObject *
1906_PyBytes_Join(PyObject *sep, PyObject *x)
1907{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001908 assert(sep != NULL && PyBytes_Check(sep));
1909 assert(x != NULL);
Martin v. Löwis0efea322014-07-27 17:29:17 +02001910 return bytes_join((PyBytesObject*)sep, x);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001911}
1912
Serhiy Storchakae09132f2016-07-03 13:57:48 +03001913static PyObject *
1914bytes_find(PyBytesObject *self, PyObject *args)
1915{
1916 return _Py_bytes_find(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1917}
1918
1919static PyObject *
1920bytes_index(PyBytesObject *self, PyObject *args)
1921{
1922 return _Py_bytes_index(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1923}
1924
1925
1926static PyObject *
1927bytes_rfind(PyBytesObject *self, PyObject *args)
1928{
1929 return _Py_bytes_rfind(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1930}
1931
1932
1933static PyObject *
1934bytes_rindex(PyBytesObject *self, PyObject *args)
1935{
1936 return _Py_bytes_rindex(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
1937}
1938
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001939
1940Py_LOCAL_INLINE(PyObject *)
1941do_xstrip(PyBytesObject *self, int striptype, PyObject *sepobj)
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001942{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001943 Py_buffer vsep;
1944 char *s = PyBytes_AS_STRING(self);
1945 Py_ssize_t len = PyBytes_GET_SIZE(self);
1946 char *sep;
1947 Py_ssize_t seplen;
1948 Py_ssize_t i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001949
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02001950 if (PyObject_GetBuffer(sepobj, &vsep, PyBUF_SIMPLE) != 0)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001951 return NULL;
1952 sep = vsep.buf;
1953 seplen = vsep.len;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001954
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001955 i = 0;
1956 if (striptype != RIGHTSTRIP) {
1957 while (i < len && memchr(sep, Py_CHARMASK(s[i]), seplen)) {
1958 i++;
1959 }
1960 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001961
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001962 j = len;
1963 if (striptype != LEFTSTRIP) {
1964 do {
1965 j--;
1966 } while (j >= i && memchr(sep, Py_CHARMASK(s[j]), seplen));
1967 j++;
1968 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001969
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001970 PyBuffer_Release(&vsep);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001971
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001972 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
1973 Py_INCREF(self);
1974 return (PyObject*)self;
1975 }
1976 else
1977 return PyBytes_FromStringAndSize(s+i, j-i);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00001978}
1979
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001980
1981Py_LOCAL_INLINE(PyObject *)
1982do_strip(PyBytesObject *self, int striptype)
1983{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001984 char *s = PyBytes_AS_STRING(self);
1985 Py_ssize_t len = PyBytes_GET_SIZE(self), i, j;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001986
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001987 i = 0;
1988 if (striptype != RIGHTSTRIP) {
David Malcolm96960882010-11-05 17:23:41 +00001989 while (i < len && Py_ISSPACE(s[i])) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001990 i++;
1991 }
1992 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00001993
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001994 j = len;
1995 if (striptype != LEFTSTRIP) {
1996 do {
1997 j--;
David Malcolm96960882010-11-05 17:23:41 +00001998 } while (j >= i && Py_ISSPACE(s[j]));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00001999 j++;
2000 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002001
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002002 if (i == 0 && j == len && PyBytes_CheckExact(self)) {
2003 Py_INCREF(self);
2004 return (PyObject*)self;
2005 }
2006 else
2007 return PyBytes_FromStringAndSize(s+i, j-i);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002008}
2009
2010
2011Py_LOCAL_INLINE(PyObject *)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002012do_argstrip(PyBytesObject *self, int striptype, PyObject *bytes)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002013{
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002014 if (bytes != NULL && bytes != Py_None) {
2015 return do_xstrip(self, striptype, bytes);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002016 }
2017 return do_strip(self, striptype);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002018}
2019
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002020/*[clinic input]
2021bytes.strip
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002022
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002023 bytes: object = None
2024 /
2025
2026Strip leading and trailing bytes contained in the argument.
2027
2028If the argument is omitted or None, strip leading and trailing ASCII whitespace.
2029[clinic start generated code]*/
2030
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002031static PyObject *
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002032bytes_strip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002033/*[clinic end generated code: output=c7c228d3bd104a1b input=8a354640e4e0b3ef]*/
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002034{
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002035 return do_argstrip(self, BOTHSTRIP, bytes);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002036}
2037
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002038/*[clinic input]
2039bytes.lstrip
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002040
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002041 bytes: object = None
2042 /
2043
2044Strip leading bytes contained in the argument.
2045
2046If the argument is omitted or None, strip leading ASCII whitespace.
2047[clinic start generated code]*/
2048
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002049static PyObject *
2050bytes_lstrip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002051/*[clinic end generated code: output=28602e586f524e82 input=9baff4398c3f6857]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002052{
2053 return do_argstrip(self, LEFTSTRIP, bytes);
2054}
2055
2056/*[clinic input]
2057bytes.rstrip
2058
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002059 bytes: object = None
2060 /
2061
2062Strip trailing bytes contained in the argument.
2063
2064If the argument is omitted or None, strip trailing ASCII whitespace.
2065[clinic start generated code]*/
2066
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002067static PyObject *
2068bytes_rstrip_impl(PyBytesObject *self, PyObject *bytes)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002069/*[clinic end generated code: output=547e3815c95447da input=b78af445c727e32b]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002070{
2071 return do_argstrip(self, RIGHTSTRIP, bytes);
Guido van Rossumad7d8d12007-04-13 01:39:34 +00002072}
Neal Norwitz6968b052007-02-27 19:02:19 +00002073
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002074
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002075static PyObject *
2076bytes_count(PyBytesObject *self, PyObject *args)
2077{
2078 return _Py_bytes_count(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2079}
2080
2081
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002082/*[clinic input]
2083bytes.translate
2084
Victor Stinner049e5092014-08-17 22:20:00 +02002085 table: object
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002086 Translation table, which must be a bytes object of length 256.
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002087 /
Martin Panter1b6c6da2016-08-27 08:35:02 +00002088 delete as deletechars: object(c_default="NULL") = b''
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002089
2090Return a copy with each character mapped by the given translation table.
2091
Martin Panter1b6c6da2016-08-27 08:35:02 +00002092All characters occurring in the optional argument delete are removed.
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002093The remaining characters are mapped through the given translation table.
2094[clinic start generated code]*/
2095
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002096static PyObject *
Martin Panter1b6c6da2016-08-27 08:35:02 +00002097bytes_translate_impl(PyBytesObject *self, PyObject *table,
Larry Hastings89964c42015-04-14 18:07:59 -04002098 PyObject *deletechars)
Martin Panter1b6c6da2016-08-27 08:35:02 +00002099/*[clinic end generated code: output=43be3437f1956211 input=0ecdf159f654233c]*/
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002100{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002101 char *input, *output;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002102 Py_buffer table_view = {NULL, NULL};
2103 Py_buffer del_table_view = {NULL, NULL};
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002104 const char *table_chars;
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002105 Py_ssize_t i, c, changed = 0;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002106 PyObject *input_obj = (PyObject*)self;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002107 const char *output_start, *del_table_chars=NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002108 Py_ssize_t inlen, tablen, dellen = 0;
2109 PyObject *result;
2110 int trans_table[256];
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002111
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002112 if (PyBytes_Check(table)) {
2113 table_chars = PyBytes_AS_STRING(table);
2114 tablen = PyBytes_GET_SIZE(table);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002115 }
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002116 else if (table == Py_None) {
2117 table_chars = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002118 tablen = 256;
2119 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002120 else {
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002121 if (PyObject_GetBuffer(table, &table_view, PyBUF_SIMPLE) != 0)
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002122 return NULL;
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002123 table_chars = table_view.buf;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002124 tablen = table_view.len;
2125 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002126
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002127 if (tablen != 256) {
2128 PyErr_SetString(PyExc_ValueError,
2129 "translation table must be 256 characters long");
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002130 PyBuffer_Release(&table_view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002131 return NULL;
2132 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002133
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002134 if (deletechars != NULL) {
2135 if (PyBytes_Check(deletechars)) {
2136 del_table_chars = PyBytes_AS_STRING(deletechars);
2137 dellen = PyBytes_GET_SIZE(deletechars);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002138 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002139 else {
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002140 if (PyObject_GetBuffer(deletechars, &del_table_view, PyBUF_SIMPLE) != 0) {
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002141 PyBuffer_Release(&table_view);
2142 return NULL;
2143 }
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002144 del_table_chars = del_table_view.buf;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002145 dellen = del_table_view.len;
2146 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002147 }
2148 else {
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002149 del_table_chars = NULL;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002150 dellen = 0;
2151 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002152
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002153 inlen = PyBytes_GET_SIZE(input_obj);
2154 result = PyBytes_FromStringAndSize((char *)NULL, inlen);
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002155 if (result == NULL) {
2156 PyBuffer_Release(&del_table_view);
2157 PyBuffer_Release(&table_view);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002158 return NULL;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002159 }
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002160 output_start = output = PyBytes_AS_STRING(result);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002161 input = PyBytes_AS_STRING(input_obj);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002162
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002163 if (dellen == 0 && table_chars != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002164 /* If no deletions are required, use faster code */
2165 for (i = inlen; --i >= 0; ) {
2166 c = Py_CHARMASK(*input++);
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002167 if (Py_CHARMASK((*output++ = table_chars[c])) != c)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002168 changed = 1;
2169 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002170 if (!changed && PyBytes_CheckExact(input_obj)) {
2171 Py_INCREF(input_obj);
2172 Py_DECREF(result);
2173 result = input_obj;
2174 }
2175 PyBuffer_Release(&del_table_view);
2176 PyBuffer_Release(&table_view);
2177 return result;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002178 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002179
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002180 if (table_chars == NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002181 for (i = 0; i < 256; i++)
2182 trans_table[i] = Py_CHARMASK(i);
2183 } else {
2184 for (i = 0; i < 256; i++)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002185 trans_table[i] = Py_CHARMASK(table_chars[i]);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002186 }
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002187 PyBuffer_Release(&table_view);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002188
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002189 for (i = 0; i < dellen; i++)
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002190 trans_table[(int) Py_CHARMASK(del_table_chars[i])] = -1;
Serhiy Storchaka4fdb6842015-02-03 01:21:08 +02002191 PyBuffer_Release(&del_table_view);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002192
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002193 for (i = inlen; --i >= 0; ) {
2194 c = Py_CHARMASK(*input++);
2195 if (trans_table[c] != -1)
2196 if (Py_CHARMASK(*output++ = (char)trans_table[c]) == c)
2197 continue;
2198 changed = 1;
2199 }
2200 if (!changed && PyBytes_CheckExact(input_obj)) {
2201 Py_DECREF(result);
2202 Py_INCREF(input_obj);
2203 return input_obj;
2204 }
2205 /* Fix the size of the resulting string */
2206 if (inlen > 0)
2207 _PyBytes_Resize(&result, output - output_start);
2208 return result;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002209}
2210
2211
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002212/*[clinic input]
2213
2214@staticmethod
2215bytes.maketrans
2216
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002217 frm: Py_buffer
2218 to: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002219 /
2220
2221Return a translation table useable for the bytes or bytearray translate method.
2222
2223The returned table will be one where each byte in frm is mapped to the byte at
2224the same position in to.
2225
2226The bytes objects frm and to must be of the same length.
2227[clinic start generated code]*/
2228
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002229static PyObject *
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002230bytes_maketrans_impl(Py_buffer *frm, Py_buffer *to)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03002231/*[clinic end generated code: output=a36f6399d4b77f6f input=de7a8fc5632bb8f1]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002232{
2233 return _Py_bytes_maketrans(frm, to);
Georg Brandlabc38772009-04-12 15:51:51 +00002234}
2235
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002236
2237/*[clinic input]
2238bytes.replace
2239
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002240 old: Py_buffer
2241 new: Py_buffer
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002242 count: Py_ssize_t = -1
2243 Maximum number of occurrences to replace.
2244 -1 (the default value) means replace all occurrences.
2245 /
2246
2247Return a copy with all occurrences of substring old replaced by new.
2248
2249If the optional argument count is given, only the first count occurrences are
2250replaced.
2251[clinic start generated code]*/
2252
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002253static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002254bytes_replace_impl(PyBytesObject *self, Py_buffer *old, Py_buffer *new,
Larry Hastings89964c42015-04-14 18:07:59 -04002255 Py_ssize_t count)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002256/*[clinic end generated code: output=994fa588b6b9c104 input=b2fbbf0bf04de8e5]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002257{
Serhiy Storchakafb81d3c2016-05-05 09:26:07 +03002258 return stringlib_replace((PyObject *)self,
2259 (const char *)old->buf, old->len,
2260 (const char *)new->buf, new->len, count);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002261}
2262
2263/** End DALKE **/
2264
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002265
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002266static PyObject *
2267bytes_startswith(PyBytesObject *self, PyObject *args)
2268{
2269 return _Py_bytes_startswith(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2270}
2271
2272static PyObject *
2273bytes_endswith(PyBytesObject *self, PyObject *args)
2274{
2275 return _Py_bytes_endswith(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self), args);
2276}
2277
2278
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002279/*[clinic input]
2280bytes.decode
2281
2282 encoding: str(c_default="NULL") = 'utf-8'
2283 The encoding with which to decode the bytes.
2284 errors: str(c_default="NULL") = 'strict'
2285 The error handling scheme to use for the handling of decoding errors.
2286 The default is 'strict' meaning that decoding errors raise a
2287 UnicodeDecodeError. Other possible values are 'ignore' and 'replace'
2288 as well as any other name registered with codecs.register_error that
2289 can handle UnicodeDecodeErrors.
2290
2291Decode the bytes using the codec registered for encoding.
2292[clinic start generated code]*/
2293
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002294static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002295bytes_decode_impl(PyBytesObject *self, const char *encoding,
Larry Hastings89964c42015-04-14 18:07:59 -04002296 const char *errors)
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002297/*[clinic end generated code: output=5649a53dde27b314 input=958174769d2a40ca]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002298{
Martin v. Löwis0efea322014-07-27 17:29:17 +02002299 return PyUnicode_FromEncodedObject((PyObject*)self, encoding, errors);
Guido van Rossumd624f182006-04-24 13:47:05 +00002300}
2301
Guido van Rossum20188312006-05-05 15:15:40 +00002302
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002303/*[clinic input]
2304bytes.splitlines
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002305
Serhiy Storchaka202fda52017-03-12 10:10:47 +02002306 keepends: bool(accept={int}) = False
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002307
2308Return a list of the lines in the bytes, breaking at line boundaries.
2309
2310Line breaks are not included in the resulting list unless keepends is given and
2311true.
2312[clinic start generated code]*/
2313
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002314static PyObject *
Serhiy Storchaka7a9579c2016-05-02 13:45:20 +03002315bytes_splitlines_impl(PyBytesObject *self, int keepends)
Serhiy Storchaka202fda52017-03-12 10:10:47 +02002316/*[clinic end generated code: output=3484149a5d880ffb input=a8b32eb01ff5a5ed]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002317{
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002318 return stringlib_splitlines(
Antoine Pitroud1188562010-06-09 16:38:55 +00002319 (PyObject*) self, PyBytes_AS_STRING(self),
2320 PyBytes_GET_SIZE(self), keepends
2321 );
Antoine Pitrouf2c54842010-01-13 08:07:53 +00002322}
2323
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002324/*[clinic input]
2325@classmethod
2326bytes.fromhex
2327
2328 string: unicode
2329 /
2330
2331Create a bytes object from a string of hexadecimal numbers.
2332
2333Spaces between two numbers are accepted.
2334Example: bytes.fromhex('B9 01EF') -> b'\\xb9\\x01\\xef'.
2335[clinic start generated code]*/
2336
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002337static PyObject *
Martin v. Löwis0efea322014-07-27 17:29:17 +02002338bytes_fromhex_impl(PyTypeObject *type, PyObject *string)
Serhiy Storchaka1009bf12015-04-03 23:53:51 +03002339/*[clinic end generated code: output=0973acc63661bb2e input=bf4d1c361670acd3]*/
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002340{
Serhiy Storchaka0855e702016-07-01 17:22:31 +03002341 PyObject *result = _PyBytes_FromHex(string, 0);
2342 if (type != &PyBytes_Type && result != NULL) {
Victor Stinnerde4ae3d2016-12-04 22:59:09 +01002343 Py_SETREF(result, PyObject_CallFunctionObjArgs((PyObject *)type,
2344 result, NULL));
Serhiy Storchaka0855e702016-07-01 17:22:31 +03002345 }
2346 return result;
Victor Stinner2bf89932015-10-14 11:25:33 +02002347}
2348
2349PyObject*
2350_PyBytes_FromHex(PyObject *string, int use_bytearray)
2351{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002352 char *buf;
Victor Stinner2bf89932015-10-14 11:25:33 +02002353 Py_ssize_t hexlen, invalid_char;
2354 unsigned int top, bot;
2355 Py_UCS1 *str, *end;
2356 _PyBytesWriter writer;
2357
2358 _PyBytesWriter_Init(&writer);
2359 writer.use_bytearray = use_bytearray;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002360
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002361 assert(PyUnicode_Check(string));
2362 if (PyUnicode_READY(string))
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002363 return NULL;
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002364 hexlen = PyUnicode_GET_LENGTH(string);
Martin v. Löwisd63a3b82011-09-28 07:41:54 +02002365
Victor Stinner2bf89932015-10-14 11:25:33 +02002366 if (!PyUnicode_IS_ASCII(string)) {
2367 void *data = PyUnicode_DATA(string);
2368 unsigned int kind = PyUnicode_KIND(string);
2369 Py_ssize_t i;
2370
2371 /* search for the first non-ASCII character */
2372 for (i = 0; i < hexlen; i++) {
2373 if (PyUnicode_READ(kind, data, i) >= 128)
2374 break;
2375 }
2376 invalid_char = i;
2377 goto error;
2378 }
2379
2380 assert(PyUnicode_KIND(string) == PyUnicode_1BYTE_KIND);
2381 str = PyUnicode_1BYTE_DATA(string);
2382
2383 /* This overestimates if there are spaces */
2384 buf = _PyBytesWriter_Alloc(&writer, hexlen / 2);
2385 if (buf == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002386 return NULL;
Victor Stinner2bf89932015-10-14 11:25:33 +02002387
2388 end = str + hexlen;
2389 while (str < end) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002390 /* skip over spaces in the input */
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +02002391 if (Py_ISSPACE(*str)) {
Victor Stinner2bf89932015-10-14 11:25:33 +02002392 do {
2393 str++;
Serhiy Storchakadd1da7f2016-12-19 18:51:37 +02002394 } while (Py_ISSPACE(*str));
Victor Stinner2bf89932015-10-14 11:25:33 +02002395 if (str >= end)
2396 break;
2397 }
2398
2399 top = _PyLong_DigitValue[*str];
2400 if (top >= 16) {
2401 invalid_char = str - PyUnicode_1BYTE_DATA(string);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002402 goto error;
2403 }
Victor Stinner2bf89932015-10-14 11:25:33 +02002404 str++;
2405
2406 bot = _PyLong_DigitValue[*str];
2407 if (bot >= 16) {
2408 invalid_char = str - PyUnicode_1BYTE_DATA(string);
2409 goto error;
2410 }
2411 str++;
2412
2413 *buf++ = (unsigned char)((top << 4) + bot);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002414 }
Victor Stinner2bf89932015-10-14 11:25:33 +02002415
2416 return _PyBytesWriter_Finish(&writer, buf);
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002417
2418 error:
Victor Stinner2bf89932015-10-14 11:25:33 +02002419 PyErr_Format(PyExc_ValueError,
2420 "non-hexadecimal number found in "
2421 "fromhex() arg at position %zd", invalid_char);
2422 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002423 return NULL;
Georg Brandl0b9b9e02007-02-27 08:40:54 +00002424}
2425
Gregory P. Smith8cb65692015-04-25 23:22:26 +00002426PyDoc_STRVAR(hex__doc__,
2427"B.hex() -> string\n\
2428\n\
2429Create a string of hexadecimal numbers from a bytes object.\n\
2430Example: b'\\xb9\\x01\\xef'.hex() -> 'b901ef'.");
2431
2432static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302433bytes_hex(PyBytesObject *self, PyObject *Py_UNUSED(ignored))
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002434{
2435 char* argbuf = PyBytes_AS_STRING(self);
2436 Py_ssize_t arglen = PyBytes_GET_SIZE(self);
2437 return _Py_strhex(argbuf, arglen);
2438}
2439
2440static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302441bytes_getnewargs(PyBytesObject *v, PyObject *Py_UNUSED(ignored))
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002442{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002443 return Py_BuildValue("(y#)", v->ob_sval, Py_SIZE(v));
Guido van Rossum0dd32e22007-04-11 05:40:58 +00002444}
2445
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002446
2447static PyMethodDef
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002448bytes_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002449 {"__getnewargs__", (PyCFunction)bytes_getnewargs, METH_NOARGS},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302450 {"capitalize", stringlib_capitalize, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002451 _Py_capitalize__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002452 STRINGLIB_CENTER_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002453 {"count", (PyCFunction)bytes_count, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002454 _Py_count__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002455 BYTES_DECODE_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002456 {"endswith", (PyCFunction)bytes_endswith, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002457 _Py_endswith__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002458 STRINGLIB_EXPANDTABS_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002459 {"find", (PyCFunction)bytes_find, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002460 _Py_find__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002461 BYTES_FROMHEX_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002462 {"hex", (PyCFunction)bytes_hex, METH_NOARGS, hex__doc__},
2463 {"index", (PyCFunction)bytes_index, METH_VARARGS, _Py_index__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302464 {"isalnum", stringlib_isalnum, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002465 _Py_isalnum__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302466 {"isalpha", stringlib_isalpha, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002467 _Py_isalpha__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302468 {"isascii", stringlib_isascii, METH_NOARGS,
INADA Naokia49ac992018-01-27 14:06:21 +09002469 _Py_isascii__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302470 {"isdigit", stringlib_isdigit, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002471 _Py_isdigit__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302472 {"islower", stringlib_islower, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002473 _Py_islower__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302474 {"isspace", stringlib_isspace, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002475 _Py_isspace__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302476 {"istitle", stringlib_istitle, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002477 _Py_istitle__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302478 {"isupper", stringlib_isupper, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002479 _Py_isupper__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002480 BYTES_JOIN_METHODDEF
Tal Einatc929df32018-07-06 13:17:38 +03002481 STRINGLIB_LJUST_METHODDEF
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302482 {"lower", stringlib_lower, METH_NOARGS, _Py_lower__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002483 BYTES_LSTRIP_METHODDEF
2484 BYTES_MAKETRANS_METHODDEF
2485 BYTES_PARTITION_METHODDEF
2486 BYTES_REPLACE_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002487 {"rfind", (PyCFunction)bytes_rfind, METH_VARARGS, _Py_rfind__doc__},
2488 {"rindex", (PyCFunction)bytes_rindex, METH_VARARGS, _Py_rindex__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002489 STRINGLIB_RJUST_METHODDEF
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002490 BYTES_RPARTITION_METHODDEF
2491 BYTES_RSPLIT_METHODDEF
2492 BYTES_RSTRIP_METHODDEF
2493 BYTES_SPLIT_METHODDEF
2494 BYTES_SPLITLINES_METHODDEF
Serhiy Storchakae09132f2016-07-03 13:57:48 +03002495 {"startswith", (PyCFunction)bytes_startswith, METH_VARARGS,
Serhiy Storchakadd40fc32016-05-04 22:23:26 +03002496 _Py_startswith__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002497 BYTES_STRIP_METHODDEF
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302498 {"swapcase", stringlib_swapcase, METH_NOARGS,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002499 _Py_swapcase__doc__},
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302500 {"title", stringlib_title, METH_NOARGS, _Py_title__doc__},
Martin v. Löwis7252a6e2014-07-27 16:25:09 +02002501 BYTES_TRANSLATE_METHODDEF
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05302502 {"upper", stringlib_upper, METH_NOARGS, _Py_upper__doc__},
Tal Einatc929df32018-07-06 13:17:38 +03002503 STRINGLIB_ZFILL_METHODDEF
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002504 {NULL, NULL} /* sentinel */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002505};
2506
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002507static PyObject *
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002508bytes_mod(PyObject *self, PyObject *arg)
Ethan Furmanb95b5612015-01-23 20:05:18 -08002509{
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002510 if (!PyBytes_Check(self)) {
2511 Py_RETURN_NOTIMPLEMENTED;
Victor Stinner772b2b02015-10-14 09:56:53 +02002512 }
Victor Stinner772b2b02015-10-14 09:56:53 +02002513 return _PyBytes_FormatEx(PyBytes_AS_STRING(self), PyBytes_GET_SIZE(self),
Serhiy Storchakac9a59e62016-04-15 14:11:10 +03002514 arg, 0);
Ethan Furmanb95b5612015-01-23 20:05:18 -08002515}
2516
2517static PyNumberMethods bytes_as_number = {
2518 0, /*nb_add*/
2519 0, /*nb_subtract*/
2520 0, /*nb_multiply*/
2521 bytes_mod, /*nb_remainder*/
2522};
2523
2524static PyObject *
Serhiy Storchaka15095802015-11-25 15:47:01 +02002525bytes_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002526
2527static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002528bytes_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002529{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002530 PyObject *x = NULL;
2531 const char *encoding = NULL;
2532 const char *errors = NULL;
2533 PyObject *new = NULL;
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002534 PyObject *func;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002535 Py_ssize_t size;
2536 static char *kwlist[] = {"source", "encoding", "errors", 0};
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002537 _Py_IDENTIFIER(__bytes__);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002538
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002539 if (type != &PyBytes_Type)
Serhiy Storchaka15095802015-11-25 15:47:01 +02002540 return bytes_subtype_new(type, args, kwds);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002541 if (!PyArg_ParseTupleAndKeywords(args, kwds, "|Oss:bytes", kwlist, &x,
2542 &encoding, &errors))
2543 return NULL;
2544 if (x == NULL) {
2545 if (encoding != NULL || errors != NULL) {
2546 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka2c2044e2018-10-21 15:29:12 +03002547 encoding != NULL ?
2548 "encoding without a string argument" :
2549 "errors without a string argument");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002550 return NULL;
2551 }
Victor Stinnerdb067af2014-05-02 22:31:14 +02002552 return PyBytes_FromStringAndSize(NULL, 0);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002553 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002554
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002555 if (encoding != NULL) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002556 /* Encode via the codec registry */
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002557 if (!PyUnicode_Check(x)) {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002558 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002559 "encoding without a string argument");
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002560 return NULL;
2561 }
2562 new = PyUnicode_AsEncodedString(x, encoding, errors);
2563 if (new == NULL)
2564 return NULL;
2565 assert(PyBytes_Check(new));
2566 return new;
2567 }
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002568
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002569 if (errors != NULL) {
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +02002570 PyErr_SetString(PyExc_TypeError,
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002571 PyUnicode_Check(x) ?
2572 "string argument without an encoding" :
2573 "errors without a string argument");
Serhiy Storchaka83cf99d2014-12-02 09:24:06 +02002574 return NULL;
2575 }
2576
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002577 /* We'd like to call PyObject_Bytes here, but we need to check for an
2578 integer argument before deferring to PyBytes_FromObject, something
2579 PyObject_Bytes doesn't do. */
2580 func = _PyObject_LookupSpecial(x, &PyId___bytes__);
2581 if (func != NULL) {
Victor Stinnerf17c3de2016-12-06 18:46:19 +01002582 new = _PyObject_CallNoArg(func);
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002583 Py_DECREF(func);
2584 if (new == NULL)
2585 return NULL;
2586 if (!PyBytes_Check(new)) {
2587 PyErr_Format(PyExc_TypeError,
2588 "__bytes__ returned non-bytes (type %.200s)",
2589 Py_TYPE(new)->tp_name);
2590 Py_DECREF(new);
2591 return NULL;
2592 }
2593 return new;
2594 }
2595 else if (PyErr_Occurred())
2596 return NULL;
2597
Serhiy Storchaka5aac3ed2015-12-20 16:36:34 +02002598 if (PyUnicode_Check(x)) {
2599 PyErr_SetString(PyExc_TypeError,
2600 "string argument without an encoding");
2601 return NULL;
2602 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002603 /* Is it an integer? */
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002604 if (PyIndex_Check(x)) {
2605 size = PyNumber_AsSsize_t(x, PyExc_OverflowError);
2606 if (size == -1 && PyErr_Occurred()) {
Serhiy Storchakae8904212018-10-15 00:02:57 +03002607 if (!PyErr_ExceptionMatches(PyExc_TypeError))
INADA Naokia634e232017-01-06 17:32:01 +09002608 return NULL;
2609 PyErr_Clear(); /* fall through */
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002610 }
INADA Naokia634e232017-01-06 17:32:01 +09002611 else {
2612 if (size < 0) {
2613 PyErr_SetString(PyExc_ValueError, "negative count");
2614 return NULL;
2615 }
2616 new = _PyBytes_FromSize(size, 1);
2617 if (new == NULL)
2618 return NULL;
2619 return new;
Serhiy Storchakaeb249882016-08-15 09:46:07 +03002620 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002621 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002622
Benjamin Peterson5ff3f732012-12-19 15:27:41 -06002623 return PyBytes_FromObject(x);
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002624}
2625
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002626static PyObject*
2627_PyBytes_FromBuffer(PyObject *x)
2628{
2629 PyObject *new;
2630 Py_buffer view;
2631
2632 if (PyObject_GetBuffer(x, &view, PyBUF_FULL_RO) < 0)
2633 return NULL;
2634
2635 new = PyBytes_FromStringAndSize(NULL, view.len);
2636 if (!new)
2637 goto fail;
2638 if (PyBuffer_ToContiguous(((PyBytesObject *)new)->ob_sval,
2639 &view, view.len, 'C') < 0)
2640 goto fail;
2641 PyBuffer_Release(&view);
2642 return new;
2643
2644fail:
2645 Py_XDECREF(new);
2646 PyBuffer_Release(&view);
2647 return NULL;
2648}
2649
2650static PyObject*
2651_PyBytes_FromList(PyObject *x)
2652{
Serhiy Storchaka914f9a02018-10-21 15:25:53 +03002653 Py_ssize_t i, size = PyList_GET_SIZE(x);
2654 Py_ssize_t value;
2655 char *str;
2656 PyObject *item;
2657 _PyBytesWriter writer;
2658
2659 _PyBytesWriter_Init(&writer);
2660 str = _PyBytesWriter_Alloc(&writer, size);
2661 if (str == NULL)
2662 return NULL;
2663 writer.overallocate = 1;
2664 size = writer.allocated;
2665
2666 for (i = 0; i < PyList_GET_SIZE(x); i++) {
2667 item = PyList_GET_ITEM(x, i);
2668 Py_INCREF(item);
2669 value = PyNumber_AsSsize_t(item, NULL);
2670 Py_DECREF(item);
2671 if (value == -1 && PyErr_Occurred())
2672 goto error;
2673
2674 if (value < 0 || value >= 256) {
2675 PyErr_SetString(PyExc_ValueError,
2676 "bytes must be in range(0, 256)");
2677 goto error;
2678 }
2679
2680 if (i >= size) {
2681 str = _PyBytesWriter_Resize(&writer, str, size+1);
2682 if (str == NULL)
2683 return NULL;
2684 size = writer.allocated;
2685 }
2686 *str++ = (char) value;
2687 }
2688 return _PyBytesWriter_Finish(&writer, str);
2689
2690 error:
2691 _PyBytesWriter_Dealloc(&writer);
2692 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002693}
2694
2695static PyObject*
2696_PyBytes_FromTuple(PyObject *x)
2697{
Serhiy Storchaka914f9a02018-10-21 15:25:53 +03002698 PyObject *bytes;
2699 Py_ssize_t i, size = PyTuple_GET_SIZE(x);
2700 Py_ssize_t value;
2701 char *str;
2702 PyObject *item;
2703
2704 bytes = PyBytes_FromStringAndSize(NULL, size);
2705 if (bytes == NULL)
2706 return NULL;
2707 str = ((PyBytesObject *)bytes)->ob_sval;
2708
2709 for (i = 0; i < size; i++) {
2710 item = PyTuple_GET_ITEM(x, i);
2711 value = PyNumber_AsSsize_t(item, NULL);
2712 if (value == -1 && PyErr_Occurred())
2713 goto error;
2714
2715 if (value < 0 || value >= 256) {
2716 PyErr_SetString(PyExc_ValueError,
2717 "bytes must be in range(0, 256)");
2718 goto error;
2719 }
2720 *str++ = (char) value;
2721 }
2722 return bytes;
2723
2724 error:
2725 Py_DECREF(bytes);
2726 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002727}
2728
2729static PyObject *
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002730_PyBytes_FromIterator(PyObject *it, PyObject *x)
Benjamin Petersonc15a0732008-08-26 16:46:47 +00002731{
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002732 char *str;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002733 Py_ssize_t i, size;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002734 _PyBytesWriter writer;
2735
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002736 /* For iterator version, create a string object and resize as needed */
Armin Ronacheraa9a79d2012-10-06 14:03:24 +02002737 size = PyObject_LengthHint(x, 64);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002738 if (size == -1 && PyErr_Occurred())
2739 return NULL;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002740
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002741 _PyBytesWriter_Init(&writer);
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002742 str = _PyBytesWriter_Alloc(&writer, size);
2743 if (str == NULL)
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002744 return NULL;
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002745 writer.overallocate = 1;
2746 size = writer.allocated;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002747
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002748 /* Run the iterator to exhaustion */
2749 for (i = 0; ; i++) {
2750 PyObject *item;
2751 Py_ssize_t value;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002752
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002753 /* Get the next item */
2754 item = PyIter_Next(it);
2755 if (item == NULL) {
2756 if (PyErr_Occurred())
2757 goto error;
2758 break;
2759 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002760
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002761 /* Interpret it as an int (__index__) */
Serhiy Storchakaf54d7812016-07-06 21:39:44 +03002762 value = PyNumber_AsSsize_t(item, NULL);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002763 Py_DECREF(item);
2764 if (value == -1 && PyErr_Occurred())
2765 goto error;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002766
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002767 /* Range check */
2768 if (value < 0 || value >= 256) {
2769 PyErr_SetString(PyExc_ValueError,
2770 "bytes must be in range(0, 256)");
2771 goto error;
2772 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002773
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002774 /* Append the byte */
2775 if (i >= size) {
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002776 str = _PyBytesWriter_Resize(&writer, str, size+1);
2777 if (str == NULL)
2778 return NULL;
2779 size = writer.allocated;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002780 }
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002781 *str++ = (char) value;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002782 }
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002783
2784 return _PyBytesWriter_Finish(&writer, str);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002785
2786 error:
Victor Stinnerc3d2bc12015-10-14 14:15:49 +02002787 _PyBytesWriter_Dealloc(&writer);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002788 return NULL;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002789}
2790
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002791PyObject *
2792PyBytes_FromObject(PyObject *x)
2793{
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002794 PyObject *it, *result;
2795
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002796 if (x == NULL) {
2797 PyErr_BadInternalCall();
2798 return NULL;
2799 }
2800
2801 if (PyBytes_CheckExact(x)) {
2802 Py_INCREF(x);
2803 return x;
2804 }
2805
2806 /* Use the modern buffer interface */
2807 if (PyObject_CheckBuffer(x))
2808 return _PyBytes_FromBuffer(x);
2809
2810 if (PyList_CheckExact(x))
2811 return _PyBytes_FromList(x);
2812
2813 if (PyTuple_CheckExact(x))
2814 return _PyBytes_FromTuple(x);
2815
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002816 if (!PyUnicode_Check(x)) {
2817 it = PyObject_GetIter(x);
2818 if (it != NULL) {
2819 result = _PyBytes_FromIterator(it, x);
2820 Py_DECREF(it);
2821 return result;
2822 }
Serhiy Storchakae8904212018-10-15 00:02:57 +03002823 if (!PyErr_ExceptionMatches(PyExc_TypeError)) {
2824 return NULL;
2825 }
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002826 }
2827
Serhiy Storchaka03f17f82016-04-10 14:44:59 +03002828 PyErr_Format(PyExc_TypeError,
2829 "cannot convert '%.200s' object to bytes",
2830 x->ob_type->tp_name);
2831 return NULL;
Victor Stinnerf2eafa32015-10-14 13:44:29 +02002832}
2833
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002834static PyObject *
Serhiy Storchaka15095802015-11-25 15:47:01 +02002835bytes_subtype_new(PyTypeObject *type, PyObject *args, PyObject *kwds)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002836{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002837 PyObject *tmp, *pnew;
2838 Py_ssize_t n;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002839
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002840 assert(PyType_IsSubtype(type, &PyBytes_Type));
2841 tmp = bytes_new(&PyBytes_Type, args, kwds);
2842 if (tmp == NULL)
2843 return NULL;
Serhiy Storchaka15095802015-11-25 15:47:01 +02002844 assert(PyBytes_Check(tmp));
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002845 n = PyBytes_GET_SIZE(tmp);
2846 pnew = type->tp_alloc(type, n);
2847 if (pnew != NULL) {
Christian Heimesf051e432016-09-13 20:22:02 +02002848 memcpy(PyBytes_AS_STRING(pnew),
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002849 PyBytes_AS_STRING(tmp), n+1);
2850 ((PyBytesObject *)pnew)->ob_shash =
2851 ((PyBytesObject *)tmp)->ob_shash;
2852 }
2853 Py_DECREF(tmp);
2854 return pnew;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002855}
2856
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002857PyDoc_STRVAR(bytes_doc,
Georg Brandl17cb8a82008-05-30 08:20:09 +00002858"bytes(iterable_of_ints) -> bytes\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002859bytes(string, encoding[, errors]) -> bytes\n\
Georg Brandl17cb8a82008-05-30 08:20:09 +00002860bytes(bytes_or_buffer) -> immutable copy of bytes_or_buffer\n\
Victor Stinnerbb2e9c42011-12-17 23:18:07 +01002861bytes(int) -> bytes object of size given by the parameter initialized with null bytes\n\
2862bytes() -> empty bytes object\n\
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002863\n\
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002864Construct an immutable array of bytes from:\n\
Guido van Rossum98297ee2007-11-06 21:34:58 +00002865 - an iterable yielding integers in range(256)\n\
2866 - a text string encoded using the specified encoding\n\
Victor Stinnerbb2e9c42011-12-17 23:18:07 +01002867 - any object implementing the buffer API.\n\
2868 - an integer");
Guido van Rossum98297ee2007-11-06 21:34:58 +00002869
Benjamin Peterson80688ef2009-04-18 15:17:02 +00002870static PyObject *bytes_iter(PyObject *seq);
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002871
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002872PyTypeObject PyBytes_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002873 PyVarObject_HEAD_INIT(&PyType_Type, 0)
2874 "bytes",
2875 PyBytesObject_SIZE,
2876 sizeof(char),
2877 bytes_dealloc, /* tp_dealloc */
2878 0, /* tp_print */
2879 0, /* tp_getattr */
2880 0, /* tp_setattr */
2881 0, /* tp_reserved */
2882 (reprfunc)bytes_repr, /* tp_repr */
Ethan Furmanb95b5612015-01-23 20:05:18 -08002883 &bytes_as_number, /* tp_as_number */
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002884 &bytes_as_sequence, /* tp_as_sequence */
2885 &bytes_as_mapping, /* tp_as_mapping */
2886 (hashfunc)bytes_hash, /* tp_hash */
2887 0, /* tp_call */
2888 bytes_str, /* tp_str */
2889 PyObject_GenericGetAttr, /* tp_getattro */
2890 0, /* tp_setattro */
2891 &bytes_as_buffer, /* tp_as_buffer */
2892 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE |
2893 Py_TPFLAGS_BYTES_SUBCLASS, /* tp_flags */
2894 bytes_doc, /* tp_doc */
2895 0, /* tp_traverse */
2896 0, /* tp_clear */
2897 (richcmpfunc)bytes_richcompare, /* tp_richcompare */
2898 0, /* tp_weaklistoffset */
2899 bytes_iter, /* tp_iter */
2900 0, /* tp_iternext */
2901 bytes_methods, /* tp_methods */
2902 0, /* tp_members */
2903 0, /* tp_getset */
2904 &PyBaseObject_Type, /* tp_base */
2905 0, /* tp_dict */
2906 0, /* tp_descr_get */
2907 0, /* tp_descr_set */
2908 0, /* tp_dictoffset */
2909 0, /* tp_init */
2910 0, /* tp_alloc */
2911 bytes_new, /* tp_new */
2912 PyObject_Del, /* tp_free */
Guido van Rossum4dfe8a12006-04-22 23:28:04 +00002913};
Guido van Rossuma5d2d552007-10-26 17:39:48 +00002914
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002915void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002916PyBytes_Concat(PyObject **pv, PyObject *w)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002917{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002918 assert(pv != NULL);
2919 if (*pv == NULL)
2920 return;
2921 if (w == NULL) {
Serhiy Storchakaf458a032013-02-02 18:45:22 +02002922 Py_CLEAR(*pv);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002923 return;
2924 }
Antoine Pitrou161d6952014-05-01 14:36:20 +02002925
2926 if (Py_REFCNT(*pv) == 1 && PyBytes_CheckExact(*pv)) {
2927 /* Only one reference, so we can resize in place */
Zachary Warebca96942014-05-06 11:42:37 -05002928 Py_ssize_t oldsize;
Antoine Pitrou161d6952014-05-01 14:36:20 +02002929 Py_buffer wb;
Victor Stinner049e5092014-08-17 22:20:00 +02002930
Antoine Pitrou161d6952014-05-01 14:36:20 +02002931 wb.len = -1;
Serhiy Storchaka3dd3e262015-02-03 01:25:42 +02002932 if (PyObject_GetBuffer(w, &wb, PyBUF_SIMPLE) != 0) {
Antoine Pitrou161d6952014-05-01 14:36:20 +02002933 PyErr_Format(PyExc_TypeError, "can't concat %.100s to %.100s",
2934 Py_TYPE(w)->tp_name, Py_TYPE(*pv)->tp_name);
2935 Py_CLEAR(*pv);
2936 return;
2937 }
2938
2939 oldsize = PyBytes_GET_SIZE(*pv);
2940 if (oldsize > PY_SSIZE_T_MAX - wb.len) {
2941 PyErr_NoMemory();
2942 goto error;
2943 }
2944 if (_PyBytes_Resize(pv, oldsize + wb.len) < 0)
2945 goto error;
2946
2947 memcpy(PyBytes_AS_STRING(*pv) + oldsize, wb.buf, wb.len);
2948 PyBuffer_Release(&wb);
2949 return;
2950
2951 error:
2952 PyBuffer_Release(&wb);
2953 Py_CLEAR(*pv);
2954 return;
2955 }
2956
2957 else {
2958 /* Multiple references, need to create new object */
2959 PyObject *v;
2960 v = bytes_concat(*pv, w);
Serhiy Storchaka57a01d32016-04-10 18:05:40 +03002961 Py_SETREF(*pv, v);
Antoine Pitrou161d6952014-05-01 14:36:20 +02002962 }
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002963}
2964
2965void
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002966PyBytes_ConcatAndDel(PyObject **pv, PyObject *w)
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002967{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002968 PyBytes_Concat(pv, w);
2969 Py_XDECREF(w);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002970}
2971
2972
Ethan Furmanb95b5612015-01-23 20:05:18 -08002973/* The following function breaks the notion that bytes are immutable:
2974 it changes the size of a bytes object. We get away with this only if there
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002975 is only one module referencing the object. You can also think of it
Ethan Furmanb95b5612015-01-23 20:05:18 -08002976 as creating a new bytes object and destroying the old one, only
2977 more efficiently. In any case, don't use this if the bytes object may
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002978 already be known to some other part of the code...
Ethan Furmanb95b5612015-01-23 20:05:18 -08002979 Note that if there's not enough memory to resize the bytes object, the
2980 original bytes object at *pv is deallocated, *pv is set to NULL, an "out of
Christian Heimes2c9c7a52008-05-26 13:42:13 +00002981 memory" exception is set, and -1 is returned. Else (on success) 0 is
2982 returned, and the value in *pv may or may not be the same as on input.
2983 As always, an extra byte is allocated for a trailing \0 byte (newsize
2984 does *not* include that), and a trailing \0 byte is stored.
2985*/
2986
2987int
2988_PyBytes_Resize(PyObject **pv, Py_ssize_t newsize)
2989{
Antoine Pitrou9ed5f272013-08-13 20:18:52 +02002990 PyObject *v;
2991 PyBytesObject *sv;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00002992 v = *pv;
Berker Peksag4a72a7b2016-09-16 17:31:06 +03002993 if (!PyBytes_Check(v) || newsize < 0) {
2994 goto error;
2995 }
2996 if (Py_SIZE(v) == newsize) {
2997 /* return early if newsize equals to v->ob_size */
2998 return 0;
2999 }
Serhiy Storchaka44cc4822019-01-12 09:22:29 +02003000 if (Py_SIZE(v) == 0) {
3001 if (newsize == 0) {
3002 return 0;
3003 }
3004 *pv = _PyBytes_FromSize(newsize, 0);
3005 Py_DECREF(v);
3006 return (*pv == NULL) ? -1 : 0;
3007 }
Berker Peksag4a72a7b2016-09-16 17:31:06 +03003008 if (Py_REFCNT(v) != 1) {
3009 goto error;
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003010 }
Serhiy Storchaka44cc4822019-01-12 09:22:29 +02003011 if (newsize == 0) {
3012 *pv = _PyBytes_FromSize(0, 0);
3013 Py_DECREF(v);
3014 return (*pv == NULL) ? -1 : 0;
3015 }
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003016 /* XXX UNREF/NEWREF interface should be more symmetrical */
3017 _Py_DEC_REFTOTAL;
3018 _Py_ForgetReference(v);
3019 *pv = (PyObject *)
Serhiy Storchaka20b39b22014-09-28 11:27:24 +03003020 PyObject_REALLOC(v, PyBytesObject_SIZE + newsize);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003021 if (*pv == NULL) {
3022 PyObject_Del(v);
3023 PyErr_NoMemory();
3024 return -1;
3025 }
3026 _Py_NewReference(*pv);
3027 sv = (PyBytesObject *) *pv;
3028 Py_SIZE(sv) = newsize;
3029 sv->ob_sval[newsize] = '\0';
3030 sv->ob_shash = -1; /* invalidate cached hash value */
3031 return 0;
Berker Peksag4a72a7b2016-09-16 17:31:06 +03003032error:
3033 *pv = 0;
3034 Py_DECREF(v);
3035 PyErr_BadInternalCall();
3036 return -1;
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003037}
3038
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003039void
3040PyBytes_Fini(void)
3041{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003042 int i;
Serhiy Storchakaf458a032013-02-02 18:45:22 +02003043 for (i = 0; i < UCHAR_MAX + 1; i++)
3044 Py_CLEAR(characters[i]);
3045 Py_CLEAR(nullstring);
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003046}
3047
Benjamin Peterson4116f362008-05-27 00:36:20 +00003048/*********************** Bytes Iterator ****************************/
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003049
3050typedef struct {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003051 PyObject_HEAD
3052 Py_ssize_t it_index;
3053 PyBytesObject *it_seq; /* Set to NULL when iterator is exhausted */
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003054} striterobject;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003055
3056static void
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003057striter_dealloc(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003058{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003059 _PyObject_GC_UNTRACK(it);
3060 Py_XDECREF(it->it_seq);
3061 PyObject_GC_Del(it);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003062}
3063
3064static int
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003065striter_traverse(striterobject *it, visitproc visit, void *arg)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003066{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003067 Py_VISIT(it->it_seq);
3068 return 0;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003069}
3070
3071static PyObject *
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003072striter_next(striterobject *it)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003073{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003074 PyBytesObject *seq;
3075 PyObject *item;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003076
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003077 assert(it != NULL);
3078 seq = it->it_seq;
3079 if (seq == NULL)
3080 return NULL;
3081 assert(PyBytes_Check(seq));
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003082
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003083 if (it->it_index < PyBytes_GET_SIZE(seq)) {
3084 item = PyLong_FromLong(
3085 (unsigned char)seq->ob_sval[it->it_index]);
3086 if (item != NULL)
3087 ++it->it_index;
3088 return item;
3089 }
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003090
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003091 it->it_seq = NULL;
Serhiy Storchakafbb1c5e2016-03-30 20:40:02 +03003092 Py_DECREF(seq);
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003093 return NULL;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003094}
3095
3096static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303097striter_len(striterobject *it, PyObject *Py_UNUSED(ignored))
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003098{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003099 Py_ssize_t len = 0;
3100 if (it->it_seq)
3101 len = PyBytes_GET_SIZE(it->it_seq) - it->it_index;
3102 return PyLong_FromSsize_t(len);
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003103}
3104
3105PyDoc_STRVAR(length_hint_doc,
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003106 "Private method returning an estimate of len(list(it)).");
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003107
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003108static PyObject *
Siddhesh Poyarekar55edd0c2018-04-30 00:29:33 +05303109striter_reduce(striterobject *it, PyObject *Py_UNUSED(ignored))
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003110{
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02003111 _Py_IDENTIFIER(iter);
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003112 if (it->it_seq != NULL) {
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02003113 return Py_BuildValue("N(O)n", _PyEval_GetBuiltinId(&PyId_iter),
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003114 it->it_seq, it->it_index);
3115 } else {
Serhiy Storchakabb86bf42018-12-11 08:28:18 +02003116 return Py_BuildValue("N(())", _PyEval_GetBuiltinId(&PyId_iter));
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003117 }
3118}
3119
3120PyDoc_STRVAR(reduce_doc, "Return state information for pickling.");
3121
3122static PyObject *
3123striter_setstate(striterobject *it, PyObject *state)
3124{
3125 Py_ssize_t index = PyLong_AsSsize_t(state);
3126 if (index == -1 && PyErr_Occurred())
3127 return NULL;
Kristján Valur Jónsson25dded02014-03-05 13:47:57 +00003128 if (it->it_seq != NULL) {
3129 if (index < 0)
3130 index = 0;
3131 else if (index > PyBytes_GET_SIZE(it->it_seq))
3132 index = PyBytes_GET_SIZE(it->it_seq); /* iterator exhausted */
3133 it->it_index = index;
3134 }
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003135 Py_RETURN_NONE;
3136}
3137
3138PyDoc_STRVAR(setstate_doc, "Set state information for unpickling.");
3139
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003140static PyMethodDef striter_methods[] = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003141 {"__length_hint__", (PyCFunction)striter_len, METH_NOARGS,
3142 length_hint_doc},
Kristján Valur Jónsson31668b82012-04-03 10:49:41 +00003143 {"__reduce__", (PyCFunction)striter_reduce, METH_NOARGS,
3144 reduce_doc},
3145 {"__setstate__", (PyCFunction)striter_setstate, METH_O,
3146 setstate_doc},
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003147 {NULL, NULL} /* sentinel */
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003148};
3149
Christian Heimes2c9c7a52008-05-26 13:42:13 +00003150PyTypeObject PyBytesIter_Type = {
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003151 PyVarObject_HEAD_INIT(&PyType_Type, 0)
3152 "bytes_iterator", /* tp_name */
3153 sizeof(striterobject), /* tp_basicsize */
3154 0, /* tp_itemsize */
3155 /* methods */
3156 (destructor)striter_dealloc, /* tp_dealloc */
3157 0, /* tp_print */
3158 0, /* tp_getattr */
3159 0, /* tp_setattr */
3160 0, /* tp_reserved */
3161 0, /* tp_repr */
3162 0, /* tp_as_number */
3163 0, /* tp_as_sequence */
3164 0, /* tp_as_mapping */
3165 0, /* tp_hash */
3166 0, /* tp_call */
3167 0, /* tp_str */
3168 PyObject_GenericGetAttr, /* tp_getattro */
3169 0, /* tp_setattro */
3170 0, /* tp_as_buffer */
3171 Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,/* tp_flags */
3172 0, /* tp_doc */
3173 (traverseproc)striter_traverse, /* tp_traverse */
3174 0, /* tp_clear */
3175 0, /* tp_richcompare */
3176 0, /* tp_weaklistoffset */
3177 PyObject_SelfIter, /* tp_iter */
3178 (iternextfunc)striter_next, /* tp_iternext */
3179 striter_methods, /* tp_methods */
3180 0,
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003181};
3182
3183static PyObject *
Benjamin Peterson80688ef2009-04-18 15:17:02 +00003184bytes_iter(PyObject *seq)
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003185{
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003186 striterobject *it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003187
Antoine Pitrouf95a1b32010-05-09 15:52:27 +00003188 if (!PyBytes_Check(seq)) {
3189 PyErr_BadInternalCall();
3190 return NULL;
3191 }
3192 it = PyObject_GC_New(striterobject, &PyBytesIter_Type);
3193 if (it == NULL)
3194 return NULL;
3195 it->it_index = 0;
3196 Py_INCREF(seq);
3197 it->it_seq = (PyBytesObject *)seq;
3198 _PyObject_GC_TRACK(it);
3199 return (PyObject *)it;
Guido van Rossuma5d2d552007-10-26 17:39:48 +00003200}
Victor Stinner00165072015-10-09 01:53:21 +02003201
3202
3203/* _PyBytesWriter API */
3204
3205#ifdef MS_WINDOWS
3206 /* On Windows, overallocate by 50% is the best factor */
3207# define OVERALLOCATE_FACTOR 2
3208#else
3209 /* On Linux, overallocate by 25% is the best factor */
3210# define OVERALLOCATE_FACTOR 4
3211#endif
3212
3213void
3214_PyBytesWriter_Init(_PyBytesWriter *writer)
3215{
Victor Stinner661aacc2015-10-14 09:41:48 +02003216 /* Set all attributes before small_buffer to 0 */
3217 memset(writer, 0, offsetof(_PyBytesWriter, small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003218#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003219 memset(writer->small_buffer, 0xCB, sizeof(writer->small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003220#endif
3221}
3222
3223void
3224_PyBytesWriter_Dealloc(_PyBytesWriter *writer)
3225{
3226 Py_CLEAR(writer->buffer);
3227}
3228
3229Py_LOCAL_INLINE(char*)
3230_PyBytesWriter_AsString(_PyBytesWriter *writer)
3231{
Victor Stinner661aacc2015-10-14 09:41:48 +02003232 if (writer->use_small_buffer) {
Victor Stinner00165072015-10-09 01:53:21 +02003233 assert(writer->buffer == NULL);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003234 return writer->small_buffer;
Victor Stinner00165072015-10-09 01:53:21 +02003235 }
Victor Stinner661aacc2015-10-14 09:41:48 +02003236 else if (writer->use_bytearray) {
3237 assert(writer->buffer != NULL);
3238 return PyByteArray_AS_STRING(writer->buffer);
3239 }
3240 else {
3241 assert(writer->buffer != NULL);
3242 return PyBytes_AS_STRING(writer->buffer);
3243 }
Victor Stinner00165072015-10-09 01:53:21 +02003244}
3245
3246Py_LOCAL_INLINE(Py_ssize_t)
Victor Stinner2bf89932015-10-14 11:25:33 +02003247_PyBytesWriter_GetSize(_PyBytesWriter *writer, char *str)
Victor Stinner00165072015-10-09 01:53:21 +02003248{
3249 char *start = _PyBytesWriter_AsString(writer);
3250 assert(str != NULL);
3251 assert(str >= start);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003252 assert(str - start <= writer->allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003253 return str - start;
3254}
3255
3256Py_LOCAL_INLINE(void)
3257_PyBytesWriter_CheckConsistency(_PyBytesWriter *writer, char *str)
3258{
3259#ifdef Py_DEBUG
3260 char *start, *end;
3261
Victor Stinner661aacc2015-10-14 09:41:48 +02003262 if (writer->use_small_buffer) {
Victor Stinner00165072015-10-09 01:53:21 +02003263 assert(writer->buffer == NULL);
3264 }
Victor Stinner661aacc2015-10-14 09:41:48 +02003265 else {
3266 assert(writer->buffer != NULL);
3267 if (writer->use_bytearray)
3268 assert(PyByteArray_CheckExact(writer->buffer));
3269 else
3270 assert(PyBytes_CheckExact(writer->buffer));
3271 assert(Py_REFCNT(writer->buffer) == 1);
3272 }
Victor Stinner00165072015-10-09 01:53:21 +02003273
Victor Stinner661aacc2015-10-14 09:41:48 +02003274 if (writer->use_bytearray) {
3275 /* bytearray has its own overallocation algorithm,
3276 writer overallocation must be disabled */
3277 assert(!writer->overallocate);
3278 }
3279
3280 assert(0 <= writer->allocated);
Victor Stinner53926a12015-10-09 12:37:03 +02003281 assert(0 <= writer->min_size && writer->min_size <= writer->allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003282 /* the last byte must always be null */
Victor Stinner661aacc2015-10-14 09:41:48 +02003283 start = _PyBytesWriter_AsString(writer);
Victor Stinner00165072015-10-09 01:53:21 +02003284 assert(start[writer->allocated] == 0);
3285
3286 end = start + writer->allocated;
3287 assert(str != NULL);
3288 assert(start <= str && str <= end);
3289#endif
3290}
3291
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003292void*
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003293_PyBytesWriter_Resize(_PyBytesWriter *writer, void *str, Py_ssize_t size)
Victor Stinner00165072015-10-09 01:53:21 +02003294{
3295 Py_ssize_t allocated, pos;
3296
3297 _PyBytesWriter_CheckConsistency(writer, str);
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003298 assert(writer->allocated < size);
Victor Stinner00165072015-10-09 01:53:21 +02003299
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003300 allocated = size;
Victor Stinner00165072015-10-09 01:53:21 +02003301 if (writer->overallocate
3302 && allocated <= (PY_SSIZE_T_MAX - allocated / OVERALLOCATE_FACTOR)) {
3303 /* overallocate to limit the number of realloc() */
3304 allocated += allocated / OVERALLOCATE_FACTOR;
3305 }
3306
Victor Stinner2bf89932015-10-14 11:25:33 +02003307 pos = _PyBytesWriter_GetSize(writer, str);
Victor Stinnerb3653a32015-10-09 03:38:24 +02003308 if (!writer->use_small_buffer) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003309 if (writer->use_bytearray) {
3310 if (PyByteArray_Resize(writer->buffer, allocated))
3311 goto error;
3312 /* writer->allocated can be smaller than writer->buffer->ob_alloc,
3313 but we cannot use ob_alloc because bytes may need to be moved
3314 to use the whole buffer. bytearray uses an internal optimization
3315 to avoid moving or copying bytes when bytes are removed at the
3316 beginning (ex: del bytearray[:1]). */
3317 }
3318 else {
3319 if (_PyBytes_Resize(&writer->buffer, allocated))
3320 goto error;
Victor Stinner00165072015-10-09 01:53:21 +02003321 }
3322 }
3323 else {
3324 /* convert from stack buffer to bytes object buffer */
3325 assert(writer->buffer == NULL);
3326
Victor Stinner661aacc2015-10-14 09:41:48 +02003327 if (writer->use_bytearray)
3328 writer->buffer = PyByteArray_FromStringAndSize(NULL, allocated);
3329 else
3330 writer->buffer = PyBytes_FromStringAndSize(NULL, allocated);
Victor Stinner00165072015-10-09 01:53:21 +02003331 if (writer->buffer == NULL)
Victor Stinner661aacc2015-10-14 09:41:48 +02003332 goto error;
Victor Stinner00165072015-10-09 01:53:21 +02003333
3334 if (pos != 0) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003335 char *dest;
3336 if (writer->use_bytearray)
3337 dest = PyByteArray_AS_STRING(writer->buffer);
3338 else
3339 dest = PyBytes_AS_STRING(writer->buffer);
Christian Heimesf051e432016-09-13 20:22:02 +02003340 memcpy(dest,
Victor Stinnerb3653a32015-10-09 03:38:24 +02003341 writer->small_buffer,
Victor Stinner00165072015-10-09 01:53:21 +02003342 pos);
3343 }
3344
Victor Stinnerb3653a32015-10-09 03:38:24 +02003345 writer->use_small_buffer = 0;
Victor Stinner00165072015-10-09 01:53:21 +02003346#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003347 memset(writer->small_buffer, 0xDB, sizeof(writer->small_buffer));
Victor Stinner00165072015-10-09 01:53:21 +02003348#endif
Victor Stinner00165072015-10-09 01:53:21 +02003349 }
3350 writer->allocated = allocated;
3351
3352 str = _PyBytesWriter_AsString(writer) + pos;
3353 _PyBytesWriter_CheckConsistency(writer, str);
3354 return str;
Victor Stinner661aacc2015-10-14 09:41:48 +02003355
3356error:
3357 _PyBytesWriter_Dealloc(writer);
3358 return NULL;
Victor Stinner00165072015-10-09 01:53:21 +02003359}
3360
Victor Stinnerc5c3ba42015-10-14 13:56:47 +02003361void*
3362_PyBytesWriter_Prepare(_PyBytesWriter *writer, void *str, Py_ssize_t size)
3363{
3364 Py_ssize_t new_min_size;
3365
3366 _PyBytesWriter_CheckConsistency(writer, str);
3367 assert(size >= 0);
3368
3369 if (size == 0) {
3370 /* nothing to do */
3371 return str;
3372 }
3373
3374 if (writer->min_size > PY_SSIZE_T_MAX - size) {
3375 PyErr_NoMemory();
3376 _PyBytesWriter_Dealloc(writer);
3377 return NULL;
3378 }
3379 new_min_size = writer->min_size + size;
3380
3381 if (new_min_size > writer->allocated)
3382 str = _PyBytesWriter_Resize(writer, str, new_min_size);
3383
3384 writer->min_size = new_min_size;
3385 return str;
3386}
3387
Victor Stinner00165072015-10-09 01:53:21 +02003388/* Allocate the buffer to write size bytes.
3389 Return the pointer to the beginning of buffer data.
3390 Raise an exception and return NULL on error. */
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003391void*
Victor Stinner00165072015-10-09 01:53:21 +02003392_PyBytesWriter_Alloc(_PyBytesWriter *writer, Py_ssize_t size)
3393{
3394 /* ensure that _PyBytesWriter_Alloc() is only called once */
Victor Stinner53926a12015-10-09 12:37:03 +02003395 assert(writer->min_size == 0 && writer->buffer == NULL);
Victor Stinner00165072015-10-09 01:53:21 +02003396 assert(size >= 0);
3397
Victor Stinnerb3653a32015-10-09 03:38:24 +02003398 writer->use_small_buffer = 1;
Victor Stinnerb13b97d2015-10-09 02:52:16 +02003399#ifdef Py_DEBUG
Victor Stinnerb3653a32015-10-09 03:38:24 +02003400 writer->allocated = sizeof(writer->small_buffer) - 1;
Victor Stinnerf6358a72015-10-14 12:02:39 +02003401 /* In debug mode, don't use the full small buffer because it is less
3402 efficient than bytes and bytearray objects to detect buffer underflow
3403 and buffer overflow. Use 10 bytes of the small buffer to test also
3404 code using the smaller buffer in debug mode.
3405
3406 Don't modify the _PyBytesWriter structure (use a shorter small buffer)
3407 in debug mode to also be able to detect stack overflow when running
3408 tests in debug mode. The _PyBytesWriter is large (more than 512 bytes),
3409 if Py_EnterRecursiveCall() is not used in deep C callback, we may hit a
3410 stack overflow. */
3411 writer->allocated = Py_MIN(writer->allocated, 10);
3412 /* _PyBytesWriter_CheckConsistency() requires the last byte to be 0,
3413 to detect buffer overflow */
Victor Stinnerb3653a32015-10-09 03:38:24 +02003414 writer->small_buffer[writer->allocated] = 0;
Victor Stinner00165072015-10-09 01:53:21 +02003415#else
Victor Stinnerb3653a32015-10-09 03:38:24 +02003416 writer->allocated = sizeof(writer->small_buffer);
Victor Stinner00165072015-10-09 01:53:21 +02003417#endif
Victor Stinnerb3653a32015-10-09 03:38:24 +02003418 return _PyBytesWriter_Prepare(writer, writer->small_buffer, size);
Victor Stinner00165072015-10-09 01:53:21 +02003419}
3420
3421PyObject *
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003422_PyBytesWriter_Finish(_PyBytesWriter *writer, void *str)
Victor Stinner00165072015-10-09 01:53:21 +02003423{
Victor Stinner2bf89932015-10-14 11:25:33 +02003424 Py_ssize_t size;
Victor Stinner00165072015-10-09 01:53:21 +02003425 PyObject *result;
3426
3427 _PyBytesWriter_CheckConsistency(writer, str);
3428
Victor Stinner2bf89932015-10-14 11:25:33 +02003429 size = _PyBytesWriter_GetSize(writer, str);
3430 if (size == 0 && !writer->use_bytearray) {
Victor Stinner6c2cdae2015-10-12 13:29:43 +02003431 Py_CLEAR(writer->buffer);
3432 /* Get the empty byte string singleton */
3433 result = PyBytes_FromStringAndSize(NULL, 0);
3434 }
3435 else if (writer->use_small_buffer) {
Victor Stinnere914d412016-04-15 17:52:27 +02003436 if (writer->use_bytearray) {
3437 result = PyByteArray_FromStringAndSize(writer->small_buffer, size);
3438 }
3439 else {
3440 result = PyBytes_FromStringAndSize(writer->small_buffer, size);
3441 }
Victor Stinner6c2cdae2015-10-12 13:29:43 +02003442 }
3443 else {
3444 result = writer->buffer;
3445 writer->buffer = NULL;
3446
Victor Stinner2bf89932015-10-14 11:25:33 +02003447 if (size != writer->allocated) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003448 if (writer->use_bytearray) {
Victor Stinner2bf89932015-10-14 11:25:33 +02003449 if (PyByteArray_Resize(result, size)) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003450 Py_DECREF(result);
3451 return NULL;
3452 }
3453 }
3454 else {
Victor Stinner2bf89932015-10-14 11:25:33 +02003455 if (_PyBytes_Resize(&result, size)) {
Victor Stinner661aacc2015-10-14 09:41:48 +02003456 assert(result == NULL);
3457 return NULL;
3458 }
Victor Stinner00165072015-10-09 01:53:21 +02003459 }
3460 }
Victor Stinner00165072015-10-09 01:53:21 +02003461 }
Victor Stinner00165072015-10-09 01:53:21 +02003462 return result;
3463}
Victor Stinnerce179bf2015-10-09 12:57:22 +02003464
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003465void*
Victor Stinnere9aa5952015-10-12 13:57:47 +02003466_PyBytesWriter_WriteBytes(_PyBytesWriter *writer, void *ptr,
Victor Stinnerc29e29b2015-10-12 13:12:54 +02003467 const void *bytes, Py_ssize_t size)
Victor Stinnerce179bf2015-10-09 12:57:22 +02003468{
Victor Stinnere9aa5952015-10-12 13:57:47 +02003469 char *str = (char *)ptr;
3470
Victor Stinnerce179bf2015-10-09 12:57:22 +02003471 str = _PyBytesWriter_Prepare(writer, str, size);
3472 if (str == NULL)
3473 return NULL;
3474
Christian Heimesf051e432016-09-13 20:22:02 +02003475 memcpy(str, bytes, size);
Victor Stinnerce179bf2015-10-09 12:57:22 +02003476 str += size;
3477
3478 return str;
3479}