These functions raise
when expecting a bytes parameter and called with a non-bytes parameter.
typePyBytesObject
This subtype of
represents a Python bytes object.
PyBytes_Type
Part of the
.This instance of
represents the Python bytes type; it is the same object as
in the Python layer.
intPyBytes_Check(
*o)
Return true if the object o is a bytes object or an instance of a subtype of the bytes type. This function always succeeds.
intPyBytes_CheckExact(
*o)
Return true if the object o is a bytes object, but not an instance of a subtype of the bytes type. This function always succeeds.
*PyBytes_FromString(constchar*v)
Return value: New reference. Part of the
. Thread safety:
.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(constchar*v,
len)
Return value: New reference. Part of the
. Thread safety:
.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(constchar*format, ...)
Return value: New reference. Part of the
. Thread safety:
.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.
%c
int
A single byte, represented as a C int.
%d
int
Equivalent to printf("%d").
%u
unsigned int
Equivalent to printf("%u").
%ld
long
Equivalent to printf("%ld").
%lu
unsigned long
Equivalent to printf("%lu").
%zd
Equivalent to printf("%zd").
%zu
size_t
Equivalent to printf("%zu").
%i
int
Equivalent to printf("%i").
%x
int
Equivalent to printf("%x").
%s
const char*
A null-terminated C character array.
%p
const void*
The hex representation of a C pointer. Mostly equivalent to printf("%p") except that it is guaranteed to start with the literal 0x regardless of what the platform’s 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(constchar*format, va_listvargs)
Return value: New reference. Part of the
. Thread safety:
.Identical to
except that it takes exactly two arguments.
*PyBytes_FromObject(
*o)
Return value: New reference. Part of the
. Thread safety:
Safe for concurrent use on the same object
.Return the bytes representation of object o that implements the buffer protocol.
Note
If the object implements the buffer protocol, then the buffer must not be mutated while the bytes object is being created.
PyBytes_Size(
*o)
Part of the
. Thread safety:
.Return the length of the bytes in bytes object o.
PyBytes_GET_SIZE(
*o)
Thread safety:
.Similar to
, but without error checking.
char*PyBytes_AsString(
*o)
Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.Return a pointer to the contents of o. The pointer refers to the internal buffer of o, which consists of 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,
returns NULL and raises
.
char*PyBytes_AS_STRING(
*string)
Thread safety:
Safe to call from multiple threads with external synchronization only
.Similar to
, but without error checking.
intPyBytes_AsStringAndSize(
*obj, char**buffer,
*length)
Part of the
. Thread safety:
Safe to call from multiple threads with external synchronization only
.Return the null-terminated contents of the object obj through the output variables buffer and length. Returns 0 on success.
If length is NULL, the bytes object may not contain embedded null bytes; if it does, the function returns -1 and a
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,
returns -1 and raises
.
Changed in version 3.5: Previously,
was raised when embedded null bytes were encountered in the bytes object.
voidPyBytes_Concat(
**bytes,
*newpart)
Part of the
. Thread safety:
Safe for concurrent use on the same object
.Create a new bytes object in *bytes containing the contents of newpart appended to bytes; the caller will own the new reference. The reference to the old value of bytes will be “
”. If the new object cannot be created, the old reference to bytes will still be “stolen”, the value of *bytes will be set to NULL, and the appropriate exception will be set.
Note
If newpart implements the buffer protocol, then the buffer must not be mutated while the new bytes object is being created.
voidPyBytes_ConcatAndDel(
**bytes,
*newpart)
Part of the
. Thread safety:
Safe for concurrent use on the same object
.Create a new bytes object in *bytes containing the contents of newpart appended to bytes. This version releases the
to newpart (i.e. decrements its reference count).
Note
If newpart implements the buffer protocol, then the buffer must not be mutated while the new bytes object is being created.
*PyBytes_Join(
*sep,
*iterable)
Thread safety:
Safe for concurrent use on the same object
.Similar to sep.join(iterable) in Python.
sep must be Python
object. (Note that
accepts NULL separator and treats it as a space, whereas
doesn’t accept NULL separator.)
iterable must be an iterable object yielding objects that implement the
.
On success, return a new
object. On error, set an exception and return NULL.
Added in version 3.14.
Note
If iterable objects implement the buffer protocol, then the buffers must not be mutated while the new bytes object is being created.
int_PyBytes_Resize(
**bytes,
newsize)
Thread safety:
Safe to call without external synchronization on distinct objects
.Resize a bytes object. newsize will be the new length of the bytes object. You can think of it as creating a new bytes object and destroying the old one, only more efficiently. Pass the address of an existing bytes object as an lvalue (it may be written into), and the new size desired. On success, *bytes holds the resized bytes object and 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,
is set, and -1 is returned.
*PyBytes_Repr(
*bytes, intsmartquotes)
Part of the
. Thread safety:
.Get the string representation of bytes. This function is currently used to implement bytes.__repr__() in Python.
This function does not do type checking; it is undefined behavior to pass bytes as a non-bytes object or NULL.
If smartquotes is true, the representation will use a double-quoted string instead of single-quoted string when single-quotes are present in bytes. For example, the byte string 'Python' would be represented as b"'Python'" when smartquotes is true, or b'\'Python\'' when it is false.
On success, this function returns a
to a
object containing the representation. On failure, this returns NULL with an exception set.
*PyBytes_DecodeEscape(constchar*s,
len, constchar*errors,
unicode, constchar*recode_encoding)
Part of the
. Thread safety:
.Unescape a backslash-escaped string s. s must not be NULL. len must be the size of s.
errors must be one of "strict", "replace", or "ignore". If errors is NULL, then "strict" is used by default.
On success, this function returns a
to a Python
object containing the unescaped string. On failure, this function returns NULL with an exception set.
Changed in version 3.9: unicode and recode_encoding are now unused.