On this page
Byte Array Objects
PyByteArrayObject-
This subtype of
PyObjectrepresents a Python bytearray object.
- PyTypeObject
PyByteArray_Type -
This instance of
PyTypeObjectrepresents the Python bytearray type; it is the same object asbytearrayin the Python layer.
Type check macros
-
int
PyByteArray_Check( PyObject *o ) -
Return true if the object o is a bytearray object or an instance of a subtype of the bytearray type.
-
int
PyByteArray_CheckExact( PyObject *o ) -
Return true if the object o is a bytearray object, but not an instance of a subtype of the bytearray type.
Direct API functions
- PyObject*
PyByteArray_FromObject( PyObject *o ) - Return value: New reference.
Return a new bytearray object from any object, o, that implements the buffer protocol.
- PyObject*
PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len ) - Return value: New reference.
Create a new bytearray object from string and its length, len. On failure,
NULLis returned.
- PyObject*
PyByteArray_Concat( PyObject *a, PyObject *b ) - Return value: New reference.
Concat bytearrays a and b and return a new bytearray with the result.
-
Py_ssize_t
PyByteArray_Size( PyObject *bytearray ) -
Return the size of bytearray after checking for a
NULLpointer.
-
char*
PyByteArray_AsString( PyObject *bytearray ) -
Return the contents of bytearray as a char array after checking for a
NULLpointer. The returned array always has an extra null byte appended.
-
int
PyByteArray_Resize( PyObject *bytearray, Py_ssize_t len ) -
Resize the internal buffer of bytearray to len.
Macros
These macros trade safety for speed and they don’t check pointers.
-
char*
PyByteArray_AS_STRING( PyObject *bytearray ) -
Macro version of
PyByteArray_AsString().
-
Py_ssize_t
PyByteArray_GET_SIZE( PyObject *bytearray ) -
Macro version of
PyByteArray_Size().