Merged revisions 63678,63688,63690,63696 via svnmerge from
svn+ssh://pythondev@svn.python.org/python/trunk
........
r63678 | benjamin.peterson | 2008-05-26 08:01:25 -0500 (Mon, 26 May 2008) | 2 lines
put a big note on configure.in asking people to run autoconf
........
r63688 | benjamin.peterson | 2008-05-26 09:29:09 -0500 (Mon, 26 May 2008) | 2 lines
fix a minor typo
........
r63690 | benjamin.peterson | 2008-05-26 09:51:54 -0500 (Mon, 26 May 2008) | 2 lines
fix typo (thank Georg)
........
r63696 | benjamin.peterson | 2008-05-26 10:54:26 -0500 (Mon, 26 May 2008) | 2 lines
add PyByteArray docs
........
diff --git a/Doc/c-api/bytearray.rst b/Doc/c-api/bytearray.rst
new file mode 100644
index 0000000..1b0f377
--- /dev/null
+++ b/Doc/c-api/bytearray.rst
@@ -0,0 +1,74 @@
+.. highlightlang:: c
+
+.. _bytearrayobjects:
+
+Byte Array Objects
+------------------
+
+.. index:: object: bytearray
+
+
+.. ctype:: PyByteArrayObject
+
+ This subtype of :ctype:`PyObject` represents a Python string object.
+
+
+.. cvar:: PyTypeObject PyByteArray_Type
+
+ This instance of :ctype:`PyTypeObject` represents the Python bytearray type;
+ it is the same object as ``bytearray`` in the Python layer.
+
+
+.. cfunction:: 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.
+
+
+.. cfunction:: 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.
+
+
+.. cfunction:: PyObject* PyByteArray_FromObject(PyObject *o)
+
+ Return a new bytearray object from any object, *o*, that implements the
+ buffer protocol.
+
+
+.. cfunction:: PyObject* PyByteArray_FromStringAndSize(const char *string, Py_ssize_t len)
+
+ Create a new bytearray object from *string* and it's length, *len*. On
+ failure, *NULL* is returned.
+
+
+.. cfunction:: Py_ssize_t PyByteArray_Size(PyObject *bytearray)
+
+ Return the size of *bytearray* after checking for a *NULL* pointer.
+
+
+.. cfunction:: Py_ssize_t PyByteArray_GET_SIZE(PyObject *bytearray)
+
+ Macro version of :cfunc:`PyByteArray_Size` that doesn't do pointer checking.
+
+
+.. cfunction:: char* PyByteArray_AsString(PyObject *bytearray)
+
+ Return the contents of *bytearray* as a char array after checking for a
+ *NULL* pointer.
+
+
+.. cfunction:: char* PyByteArray_AS_STRING(PyObject *bytearray)
+
+ Macro version of :cfunc:`PyByteArray_AsString` that doesn't check pointers.
+
+
+.. cfunction:: PyObject* PyByteArray_Concat(PyObject *a, PyObject *b)
+
+ Concat bytearrays *a* and *b* and return a new bytearray with the result.
+
+
+.. cfunction:: PyObject* PyByteArray_Resize(PyObject *bytearray, Py_ssize_t len)
+
+ Resize the internal buffer of *bytearray* to *len*.
diff --git a/Doc/c-api/concrete.rst b/Doc/c-api/concrete.rst
index 733a0bc..2ba0833 100644
--- a/Doc/c-api/concrete.rst
+++ b/Doc/c-api/concrete.rst
@@ -66,6 +66,7 @@
.. toctree::
bytes.rst
+ bytearray.rst
unicode.rst
buffer.rst
tuple.rst