Name	Size	Mode	Actions
abstract.rst.txt	715	0644	editdlrm
allocation.rst.txt	2653	0644	editdlrm
apiabiversion.rst.txt	2242	0644	editdlrm
arg.rst.txt	30651	0644	editdlrm
bool.rst.txt	1200	0644	editdlrm
buffer.rst.txt	22267	0644	editdlrm
bytearray.rst.txt	2250	0644	editdlrm
bytes.rst.txt	9211	0644	editdlrm
capsule.rst.txt	5741	0644	editdlrm
cell.rst.txt	1940	0644	editdlrm
code.rst.txt	1666	0644	editdlrm
codec.rst.txt	4799	0644	editdlrm
complex.rst.txt	3946	0644	editdlrm
concrete.rst.txt	2046	0644	editdlrm
conversion.rst.txt	5516	0644	editdlrm
coro.rst.txt	820	0644	editdlrm
datetime.rst.txt	6415	0644	editdlrm
descriptor.rst.txt	1111	0644	editdlrm
dict.rst.txt	7952	0644	editdlrm
exceptions.rst.txt	47814	0644	editdlrm
file.rst.txt	3248	0644	editdlrm
float.rst.txt	2243	0644	editdlrm
function.rst.txt	3348	0644	editdlrm
gcsupport.rst.txt	6057	0644	editdlrm
gen.rst.txt	1301	0644	editdlrm
import.rst.txt	12825	0644	editdlrm
index.rst.txt	613	0644	editdlrm
init.rst.txt	52383	0644	editdlrm
intro.rst.txt	28751	0644	editdlrm
iter.rst.txt	1129	0644	editdlrm
iterator.rst.txt	1640	0644	editdlrm
list.rst.txt	4735	0644	editdlrm
long.rst.txt	10436	0644	editdlrm
mapping.rst.txt	2871	0644	editdlrm
marshal.rst.txt	3561	0644	editdlrm
memory.rst.txt	21369	0644	editdlrm
memoryview.rst.txt	2348	0644	editdlrm
method.rst.txt	2818	0644	editdlrm
module.rst.txt	18266	0644	editdlrm
none.rst.txt	740	0644	editdlrm
number.rst.txt	10583	0644	editdlrm
objbuffer.rst.txt	2198	0644	editdlrm
object.rst.txt	17420	0644	editdlrm
objimpl.rst.txt	304	0644	editdlrm
refcounting.rst.txt	2909	0644	editdlrm
reflection.rst.txt	1417	0644	editdlrm
sequence.rst.txt	6547	0644	editdlrm
set.rst.txt	6144	0644	editdlrm
slice.rst.txt	2404	0644	editdlrm
stable.rst.txt	1969	0644	editdlrm
structures.rst.txt	13787	0644	editdlrm
sys.rst.txt	9944	0644	editdlrm
tuple.rst.txt	8031	0644	editdlrm
type.rst.txt	3963	0644	editdlrm
typeobj.rst.txt	60184	0644	editdlrm
unicode.rst.txt	68074	0644	editdlrm
utilities.rst.txt	414	0644	editdlrm
veryhigh.rst.txt	16655	0644	editdlrm
weakref.rst.txt	2635	0644	editdlrm

.. highlightlang:: c .. _bytesobjects: Bytes Objects ------------- These functions raise :exc:`TypeError` when expecting a bytes parameter and are called with a non-bytes parameter. .. index:: object: bytes .. c:type:: PyBytesObject This subtype of :c:type:`PyObject` represents a Python bytes object. .. c:var:: PyTypeObject PyBytes_Type This instance of :c:type:`PyTypeObject` represents the Python bytes type; it is the same object as :class:`bytes` in the Python layer. .. c:function:: int PyBytes_Check(PyObject *o) Return true if the object *o* is a bytes object or an instance of a subtype of the bytes type. .. c:function:: int PyBytes_CheckExact(PyObject *o) Return true if the object *o* is a bytes object, but not an instance of a subtype of the bytes type. .. c:function:: PyObject* PyBytes_FromString(const char *v) 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. .. c:function:: PyObject* PyBytes_FromStringAndSize(const char *v, Py_ssize_t len) 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. .. c:function:: PyObject* PyBytes_FromFormat(const char *format, ...) Take a C :c:func:`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: .. % XXX: This should be exactly the same as the table in PyErr_Format. .. % One should just refer to the other. .. % XXX: The descriptions for %zd and %zu are wrong, but the truth is complicated .. % because not all compilers support the %z width modifier -- we fake it .. % when necessary via interpolating PY_FORMAT_SIZE_T. .. tabularcolumns:: |l|l|L| +-------------------+---------------+--------------------------------+ | Format Characters | Type | Comment | +===================+===============+================================+ | :attr:`%%` | *n/a* | The literal % character. | +-------------------+---------------+--------------------------------+ | :attr:`%c` | int | A single byte, | | | | represented as a C int. | +-------------------+---------------+--------------------------------+ | :attr:`%d` | int | Exactly equivalent to | | | | ``printf("%d")``. | +-------------------+---------------+--------------------------------+ | :attr:`%u` | unsigned int | Exactly equivalent to | | | | ``printf("%u")``. | +-------------------+---------------+--------------------------------+ | :attr:`%ld` | long | Exactly equivalent to | | | | ``printf("%ld")``. | +-------------------+---------------+--------------------------------+ | :attr:`%lu` | unsigned long | Exactly equivalent to | | | | ``printf("%lu")``. | +-------------------+---------------+--------------------------------+ | :attr:`%zd` | Py_ssize_t | Exactly equivalent to | | | | ``printf("%zd")``. | +-------------------+---------------+--------------------------------+ | :attr:`%zu` | size_t | Exactly equivalent to | | | | ``printf("%zu")``. | +-------------------+---------------+--------------------------------+ | :attr:`%i` | int | Exactly equivalent to | | | | ``printf("%i")``. | +-------------------+---------------+--------------------------------+ | :attr:`%x` | int | Exactly equivalent to | | | | ``printf("%x")``. | +-------------------+---------------+--------------------------------+ | :attr:`%s` | char\* | A null-terminated C character | | | | array. | +-------------------+---------------+--------------------------------+ | :attr:`%p` | void\* | The hex representation of a C | | | | pointer. Mostly equivalent to | | | | ``printf("%p")`` except that | | | | it is guaranteed to start with | | | | the literal ``0x`` regardless | | | | of what the platform's | | | | ``printf`` yields. | +-------------------+---------------+--------------------------------+ 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. .. c:function:: PyObject* PyBytes_FromFormatV(const char *format, va_list vargs) Identical to :c:func:`PyBytes_FromFormat` except that it takes exactly two arguments. .. c:function:: PyObject* PyBytes_FromObject(PyObject *o) Return the bytes representation of object *o* that implements the buffer protocol. .. c:function:: Py_ssize_t PyBytes_Size(PyObject *o) Return the length of the bytes in bytes object *o*. .. c:function:: Py_ssize_t PyBytes_GET_SIZE(PyObject *o) Macro form of :c:func:`PyBytes_Size` but without error checking. .. c:function:: char* PyBytes_AsString(PyObject *o) 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, :c:func:`PyBytes_AsString` returns *NULL* and raises :exc:`TypeError`. .. c:function:: char* PyBytes_AS_STRING(PyObject *string) Macro form of :c:func:`PyBytes_AsString` but without error checking. .. c:function:: int PyBytes_AsStringAndSize(PyObject *obj, char **buffer, Py_ssize_t *length) 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 :exc:`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, :c:func:`PyBytes_AsStringAndSize` returns ``-1`` and raises :exc:`TypeError`. .. versionchanged:: 3.5 Previously, :exc:`TypeError` was raised when embedded null bytes were encountered in the bytes object. .. c:function:: void PyBytes_Concat(PyObject **bytes, PyObject *newpart) 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. .. c:function:: void PyBytes_ConcatAndDel(PyObject **bytes, PyObject *newpart) Create a new bytes object in *\*bytes* containing the contents of *newpart* appended to *bytes*. This version decrements the reference count of *newpart*. .. c:function:: int _PyBytes_Resize(PyObject **bytes, Py_ssize_t newsize) 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*, :exc:`MemoryError` is set, and ``-1`` is returned.