cpython/Doc/c-api/bytearray.rst

88 lines
2.1 KiB
ReStructuredText
Raw Normal View History

2008-05-26 12:54:26 -03:00
.. highlightlang:: c
.. _bytearrayobjects:
Byte Array Objects
------------------
.. index:: object: bytearray
2008-05-29 04:18:17 -03:00
.. versionadded:: 2.6
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:type:: PyByteArrayObject
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
This subtype of :c:type:`PyObject` represents a Python bytearray object.
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:var:: PyTypeObject PyByteArray_Type
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
This instance of :c:type:`PyTypeObject` represents the Python bytearray type;
2008-05-26 12:54:26 -03:00
it is the same object as ``bytearray`` in the Python layer.
Type check macros
^^^^^^^^^^^^^^^^^
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:function:: int PyByteArray_Check(PyObject *o)
2008-05-26 12:54:26 -03:00
Return true if the object *o* is a bytearray object or an instance of a
subtype of the bytearray type.
2012-01-14 11:42:02 -04:00
.. c:function:: int PyByteArray_CheckExact(PyObject *o)
2008-05-26 12:54:26 -03:00
Return true if the object *o* is a bytearray object, but not an instance of a
subtype of the bytearray type.
Direct API functions
^^^^^^^^^^^^^^^^^^^^
2012-01-14 11:42:02 -04:00
.. c:function:: PyObject* PyByteArray_FromObject(PyObject *o)
2008-05-26 12:54:26 -03:00
Return a new bytearray object from any object, *o*, that implements the
buffer protocol.
2008-05-29 04:18:17 -03:00
.. XXX expand about the buffer protocol, at least somewhere
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:function:: PyObject* PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len)
2008-05-26 12:54:26 -03:00
2008-05-30 17:44:39 -03:00
Create a new bytearray object from *string* and its length, *len*. On
2008-05-26 12:54:26 -03:00
failure, *NULL* is returned.
2012-01-14 11:42:02 -04:00
.. c:function:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b)
2008-05-26 12:54:26 -03:00
Concat bytearrays *a* and *b* and return a new bytearray with the result.
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:function:: Py_ssize_t PyByteArray_Size(PyObject *bytearray)
2008-05-26 12:54:26 -03:00
Return the size of *bytearray* after checking for a *NULL* pointer.
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:function:: char* PyByteArray_AsString(PyObject *bytearray)
2008-05-26 12:54:26 -03:00
Return the contents of *bytearray* as a char array after checking for a
*NULL* pointer.
2012-01-14 11:42:02 -04:00
.. c:function:: int PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)
2008-05-26 12:54:26 -03:00
Resize the internal buffer of *bytearray* to *len*.
2008-05-26 12:54:26 -03:00
Macros
^^^^^^
2008-05-26 12:54:26 -03:00
These macros trade safety for speed and they don't check pointers.
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:function:: char* PyByteArray_AS_STRING(PyObject *bytearray)
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
Macro version of :c:func:`PyByteArray_AsString`.
2008-05-26 12:54:26 -03:00
2012-01-14 11:42:02 -04:00
.. c:function:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)
2012-01-14 11:42:02 -04:00
Macro version of :c:func:`PyByteArray_Size`.