These functions raise TypeError
when expecting a bytes parameter and are called with a non-bytes parameter.
PyBytes_Type
This instance of PyTypeObject
represents the Python bytes type; it is the same object as bytes
in the Python layer.
PyBytes_Check
Return true if the object o is a bytes object or an instance of a subtype of the bytes type.
PyBytes_CheckExact
Return true if the object o is a bytes object, but not an instance of a subtype of the bytes type.
PyBytes_FromString
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
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
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 |
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.
For integer specifiers (d, u, ld, lu, zd, zu, i, x): the 0-conversion flag has effect even when a precision is given.
PyBytes_FromFormatV
Identical to PyBytes_FromFormat()
except that it takes exactly two arguments.
PyBytes_FromObject
Return the bytes representation of object o that implements the buffer protocol.
PyBytes_GET_SIZE
Macro form of PyBytes_Size()
but without error checking.
PyBytes_AsString
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, PyBytes_AsString()
returns NULL
and raises TypeError
.
PyBytes_AS_STRING
Macro form of PyBytes_AsString()
but without error checking.
PyBytes_AsStringAndSize
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
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 stolen. If the new object cannot be created, the old reference to bytes will still be discarded and the value of *bytes will be set to NULL
; the appropriate exception will be set.
PyBytes_ConcatAndDel
Create a new bytes object in *bytes containing the contents of newpart appended to bytes. This version decrements the reference count of newpart.
_PyBytes_Resize
A way to resize a bytes object even though it is ?immutable?. Only use this to build up a brand new bytes object; don?t use this if the bytes may already be known in other parts of the code. It is an error to call this function if the refcount on the input bytes object is not one. 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
, MemoryError
is set, and -1
is returned.