diff options
-rw-r--r-- | Doc/c-api/bytearray.rst | 74 | ||||
-rw-r--r-- | Doc/c-api/concrete.rst | 1 | ||||
-rw-r--r-- | configure.in | 5 |
3 files changed, 79 insertions, 1 deletions
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 @@ intrinsic to the Python language. .. toctree:: bytes.rst + bytearray.rst unicode.rst buffer.rst tuple.rst diff --git a/configure.in b/configure.in index b749560..9c7a4b2 100644 --- a/configure.in +++ b/configure.in @@ -1,4 +1,7 @@ -dnl Process this file with autoconf 2.0 or later to make a configure script. +dnl *********************************************** +dnl * Please run autoreconf to test your changes! * +dnl *********************************************** +dnl NOTE: autoconf 2.64 doesn't seem to work (use 2.63). # Set VERSION so we only need to edit in one place (i.e., here) m4_define(PYTHON_VERSION, 3.0) |