Объекты байтов

Эти функции генерируют исключение TypeError, когда ожидают параметр типа bytes, а вызываются с параметром другого типа.

type PyBytesObject

Этот подтип PyObject представляет объект Python типа bytes.

PyTypeObject PyBytes_Type

Часть Стабильной ABI.

Этот экземпляр PyTypeObject представляет тип Python bytes; он соответствует объекту bytes на уровне Python.

int PyBytes_Check(PyObject *o)

Возвращает true, если объект o является объектом bytes или экземпляром подтипа типа bytes. Функция всегда выполняется успешно.

int PyBytes_CheckExact(PyObject *o)

Возвращает true, если объект o является объектом bytes, но не экземпляром подтипа типа bytes. Функция всегда выполняется успешно.

PyObject *PyBytes_FromString(const char *v)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Возвращает новый объект bytes со значением, являющимся копией строки v, в случае успеха, и NULL при ошибке. Параметр v не должен быть NULL; проверка не выполняется.

PyObject *PyBytes_FromStringAndSize(const char *v, Py_ssize_t len)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Возвращает новый объект bytes со значением, являющимся копией строки v, и длиной len, в случае успеха, и NULL при ошибке. Если v является NULL, содержимое объекта bytes не инициализируется.

PyObject *PyBytes_FromFormat(const char *format, ...)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Принимает строку форматирования C-стиля format и переменное число аргументов, вычисляет размер результирующего объекта Python типа bytes и возвращает объект bytes, в который отформатированы значения. Переменные аргументы должны соответствовать C-типам и точно соответствовать символам форматирования в строке format. Разрешены следующие символы форматирования:

Символы форматирования	Тип	Комментарий
%%	n/a	Буквальный символ %.
%c	int	Один байт, представленный как C int.
%d	int	Эквивалентно printf("%d"). 1
%u	unsigned int	Эквивалентно printf("%u"). 1
%ld	long	Эквивалентно printf("%ld"). 1
%lu	unsigned long	Эквивалентно printf("%lu"). 1
%zd	Py_ssize_t	Эквивалентно printf("%zd"). 1
%zu	size_t	Эквивалентно printf("%zu"). 1
%i	int	Эквивалентно printf("%i"). 1
%x	int	Эквивалентно printf("%x"). 1
%s	const char*	Нуль-терминированная C-строка.
%p	const void*	Шестнадцатеричное представление C-указателя. В основном эквивалентно printf("%p") за исключением того, что оно гарантированно начинается с 0x независимо от того, что возвращает платформа printf.

Нераспознанный символ форматирования приводит к тому, что вся остальная часть строки форматирования копируется как есть в результирующий объект, а любые дополнительные аргументы отбрасываются.

1(1,2,3,4,5,6,7,8)

Для спецификаторов целых чисел (d, u, ld, lu, zd, zu, i, x): флаг 0-преобразования имеет эффект даже при указании точности.

PyObject *PyBytes_FromFormatV(const char *format, va_list vargs)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Идентично PyBytes_FromFormat(), за исключением того, что принимает ровно два аргумента.

PyObject *PyBytes_FromObject(PyObject *o)

Возвращаемое значение: Новая ссылка. Часть Стабильной ABI.

Возвращает представление объекта o типа bytes, который реализует протокол буфера.

Py_ssize_t PyBytes_Size(PyObject *o)

Часть Стабильной ABI.

Возвращает длину объекта bytes o.

Py_ssize_t PyBytes_GET_SIZE(PyObject *o)

Аналогично PyBytes_Size(), но без проверки ошибок.

char *PyBytes_AsString(PyObject *o)

Часть Стабильной ABI.

Возвращает указатель на содержимое o. Указатель ссылается на внутренний буфер o, который состоит из len(o) + 1 байтов. Последний байт в буфере всегда равен нулю, независимо от наличия других нулевых байтов. Данные не должны изменяться каким-либо образом, за исключением случая, когда объект был только что создан с помощью PyBytes_FromStringAndSize(NULL, size). Он не должен быть удалён. Если o вообще не является объектом bytes, PyBytes_AsString() возвращает NULL и генерирует TypeError.

char *PyBytes_AS_STRING(PyObject *string)

Аналогично PyBytes_AsString(), но без проверки ошибок.

int PyBytes_AsStringAndSize(PyObject *obj, char **buffer, Py_ssize_t *length)

Часть Стабильной ABI.

Возвращает нуль-терминированное содержимое объекта obj через выходные переменные buffer и length. Возвращает 0 в случае успеха.

Если length равно NULL, объект bytes может не содержать вложенных нулевых байтов; если содержит, функция возвращает -1 и возникает ValueError.

Буфер ссылается на внутренний буфер obj, который включает дополнительный нулевой байт в конце (не учитывается в length). Данные не должны изменяться каким-либо образом, за исключением случая, когда объект был только что создан с помощью PyBytes_FromStringAndSize(NULL, size). Он не должен быть удалён. Если obj вообще не является объектом bytes, PyBytes_AsStringAndSize() возвращает -1 и генерирует TypeError.

Изменено в версии 3.5: Ранее, TypeError генерировалось, когда встречались вложенные нулевые байты в объекте bytes.

void PyBytes_Concat(PyObject **bytes, PyObject *newpart)

Часть Стабильной ABI.

Создаёт новый объект bytes в *bytes, содержащий содержимое newpart, добавленное к bytes; вызывающий получает новую ссылку. Ссылка на старое значение bytes будет удалена. Если новый объект не может быть создан, старая ссылка на bytes всё равно будет удалена, и значение *bytes будет установлено в NULL; будет установлено соответствующее исключение.

void PyBytes_ConcatAndDel(PyObject **bytes, PyObject *newpart)

Часть Стабильной ABI.

Создаёт новый объект типа bytes в *bytes, содержащий содержимое newpart, добавленное к bytes. Этот вариант освобождает сильную ссылку на newpart (т.е. уменьшает его счётчик ссылок).

int _PyBytes_Resize(PyObject **bytes, Py_ssize_t newsize)

Способ изменения размера объекта типа bytes, несмотря на то, что он «неизменяемый». Используйте только для создания совершенно нового объекта bytes; не используйте, если объект bytes может уже быть известен в других частях кода. Ошибка возникает, если счётчик ссылок входного объекта bytes не равен единице. Передайте адрес существующего объекта bytes как lvalue (он может быть изменён), а также желаемый новый размер. В случае успеха *bytes содержит изменённый объект bytes и возвращается 0; адрес в *bytes может отличаться от входного значения. Если перераспределение не удалось, исходный объект bytes по адресу *bytes удаляется, *bytes устанавливается в NULL, MemoryError устанавливается, и возвращается -1.