These functions raise TypeError
when expecting a bytes parameter and are
called with a non-bytes parameter.
PyBytesObject
PyObject
represents a Python bytes object.PyBytes_Type
PyTypeObject
represents the Python bytes type; it is the same object as bytes
in the Python layer.PyBytes_Check
(PyObject *o)PyBytes_CheckExact
(PyObject *o)PyBytes_FromString
(const char *v)Return value: New reference.
Return a new bytes object with a copy of the string v as value on success,
and NULL
on failure. The parameter v must not be NULL
; it will not be
checked.
PyBytes_FromStringAndSize
(const char *v, Py_ssize_t len)Return value: New reference.
Return a new bytes object with a copy of the string v as value and length
len on success, and NULL
on failure. If v is NULL
, the contents of
the bytes object are uninitialized.
PyBytes_FromFormat
(const char *format, ...)Return value: New reference.
Take a C printf()
-style format string and a variable number of
arguments, calculate the size of the resulting Python bytes object and return
a bytes object with the values formatted into it. The variable arguments
must be C types and must correspond exactly to the format characters in the
format string. The following format characters are allowed:
Format Characters |
Type |
Comment |
---|---|---|
|
n/a |
The literal % character. |
|
int |
A single byte, represented as a C int. |
|
int |
Equivalent to
|
|
unsigned int |
Equivalent to
|
|
long |
Equivalent to
|
|
unsigned long |
Equivalent to
|
|
Py_ssize_t |
Equivalent to
|
|
size_t |
Equivalent to
|
|
int |
Equivalent to
|
|
int |
Equivalent to
|
|
const char* |
A null-terminated C character array. |
|
const void* |
The hex representation of a C pointer. Mostly equivalent to
printf yields.
|
An unrecognized format character causes all the rest of the format string to be copied as-is to the result object, and any extra arguments discarded.
PyBytes_FromFormatV
(const char *format, va_list vargs)Return value: New reference.
Identical to PyBytes_FromFormat()
except that it takes exactly two
arguments.
PyBytes_FromObject
(PyObject *o)Return value: New reference.
Return the bytes representation of object o that implements the buffer protocol.
PyBytes_Size
(PyObject *o)PyBytes_GET_SIZE
(PyObject *o)PyBytes_Size()
but without error checking.PyBytes_AsString
(PyObject *o)len(o) + 1
bytes. The last byte in the buffer is always null, regardless of whether there are any other null bytes. The data must not be modified in any way, unless the object was just created using PyBytes_FromStringAndSize(NULL, size)
. It must not be deallocated. If o is not a bytes object at all, PyBytes_AsString()
returns NULL
and raises TypeError
.PyBytes_AS_STRING
(PyObject *string)PyBytes_AsString()
but without error checking.PyBytes_AsStringAndSize
(PyObject *obj, char **buffer, Py_ssize_t *length)Return the null-terminated contents of the object obj through the output variables buffer and length.
If length is NULL
, the bytes object
may not contain embedded null bytes;
if it does, the function returns -1
and a ValueError
is raised.
The buffer refers to an internal buffer of obj, which includes an
additional null byte at the end (not counted in length). The data
must not be modified in any way, unless the object was just created using
PyBytes_FromStringAndSize(NULL, size)
. It must not be deallocated. If
obj is not a bytes object at all, PyBytes_AsStringAndSize()
returns -1
and raises TypeError
.
Changed in version 3.5: Previously, TypeError
was raised when embedded null bytes were
encountered in the bytes object.
PyBytes_Concat
(PyObject **bytes, PyObject *newpart)NULL
; the appropriate exception will be set.PyBytes_ConcatAndDel
(PyObject **bytes, PyObject *newpart)_PyBytes_Resize
(PyObject **bytes, Py_ssize_t newsize)0
is returned; the address in *bytes may differ from its input value. If the reallocation fails, the original bytes object at *bytes is deallocated, *bytes is set to NULL
, MemoryError
is set, and -1
is returned.