Spec-Zone.ru › Python 3.10

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

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

type PyBytesObject

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

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

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

int PyBytes_Check(PyObject *o)

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

int PyBytes_CheckExact(PyObject *o)

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

PyObject *PyBytes_FromString(const char *v)
Значение возврата: новая ссылка. Часть Стабильной ABI.

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

PyObject *PyBytes_FromStringAndSize(const char *v, Py_ssize_t len)
Значение возврата: новая ссылка. Часть Стабильной ABI.

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

PyObject *PyBytes_FromFormat(const char *format, ...)
Значение возврата: новая ссылка. Часть Стабильной ABI.

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

Символы формата

Тип

Комментарий

%%

n/a

Буквальный символ %.

%c

int

Один байт, представленный как целочисленная переменная C.

%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 в виде байтов, реализующего протокол буфера.

Py_ssize_t PyBytes_Size(PyObject *o)
Часть Стабильной ABI.

Возвращает длину байтов в объекте байтов 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 вообще не является объектом байтов, 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.

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

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

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

void PyBytes_Concat(PyObject **bytes, PyObject *newpart)
Часть Стабильной ABI.

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

void PyBytes_ConcatAndDel(PyObject **bytes, PyObject *newpart)
Часть Стабильной ABI.

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

END_OF_DOCUMENT_MARKER
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 возвращается.

© 2001–2023 Python Software Foundation
Licensed under the PSF License.
https://docs.python.org/3.10/c-api/bytes.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API