# 字节对象

当期望带一个字节串形参但却带一个非字节串形参被调用时，这些函数会引发 `TypeError`。

`PyBytesObject`

  这种 `PyObject` 的子类型表示一个 Python 字节对象。

PyTypeObject `PyBytes_Type`

  `PyTypeObject` 的实例代表一个 Python 字节类型，在 Python 层面它与 `bytes` 是相同的对象。

int `PyBytes_Check`(PyObject *o)

  如果对象 o 是字节对象或字节类型的子类型的实例，则返回 true。

int `PyBytes_CheckExact`(PyObject *o)

  如果对象 o 是字节对象，但不是字节类型子类型的实例，则返回 true。

PyObject* `PyBytes_FromString`(const char *v)
  Return value: New reference.

  成功时返回一个以字符串 v 的副本为值的新字节串对象，失败时返回 `NULL`。 形参 v 不可为 `NULL`；它不会被检查。

PyObject* `PyBytes_FromStringAndSize`(const char *v, Py_ssize_t len)
  Return value: New reference.

  成功时返回一个以字符串 v 的副本为值且长度为 len 的新字节串对象，失败时返回 `NULL`。 如果 v 为 `NULL`，则不初始化字节串对象的内容。

PyObject* `PyBytes_FromFormat`(const char *format, ...)
  Return value: New reference.

  接受一个 C `printf()` 风格的 format 字符串和可变数量的参数，计算结果 Python 字节串对象的大小并返回参数值经格式化后的字节串对象。 可变数量的参数必须均为 C 类型并且必须恰好与 format 字符串中的格式字符相对应。 允许使用下列格式字符串:

  格式字符 | 类型 | 注释
  --- | --- | ---
  `%%` | 不适用 | 文字%字符。
  `%c` | int | 一个字节，被表示为一个 C 语言的整型
  `%d` | int | 相当于 `printf("%d")`. 1
  `%u` | 无符号整型 | 相当于 `printf("%u")`. 1
  `%ld` | 长整型 | 相当于 `printf("%ld")`. 1
  `%lu` | 无符号长整型 | 相当于 `printf("%lu")`. 1
  `%zd` | Py_ssize_t | 相当于 `printf("%zd")`. 1
  `%zu` | size_t | 相当于 `printf("%zu")`. 1
  `%i` | int | 相当于 `printf("%i")`. 1
  `%x` | int | 相当于 `printf("%x")`. 1
  `%s` | const char* | 以 null 为终止符的 C 字符数组。
  `%p` | const void* | 一个 C 指针的十六进制表示形式。 基本等价于 `printf("%p")` 但它会确保以字面值 `0x` 开头，不论系统平台上 `printf` 的输出是什么。

  无法识别的格式字符会导致将格式字符串的其余所有内容原样复制到结果对象，并丢弃所有多余的参数。

  1(1,2,3,4,5,6,7,8)

    对于整数说明符（d，u，ld，lu，zd，zu，i，x）：当给出精度时，0 转换标志是有效的。

PyObject* `PyBytes_FromFormatV`(const char *format, va_list vargs)
  Return value: New reference.

  与 `PyBytes_FromFormat()` 完全相同，除了它需要两个参数。

PyObject* `PyBytes_FromObject`(PyObject *o)
  Return value: New reference.

  返回字节表示实现缓冲区协议的对象*o*。

Py_ssize_t `PyBytes_Size`(PyObject *o)

  返回字节对象*o*中字节的长度。

Py_ssize_t `PyBytes_GET_SIZE`(PyObject *o)

  宏版本的 `PyBytes_Size()` 但是不带错误检测。

char* `PyBytes_AsString`(PyObject *o)

  返回对应 o 的内容的指针。 该指针指向 o 的内部缓冲区，其中包含 `len(o) + 1` 个字节。 缓冲区的最后一个字节总是为空，不论是否存在其他空字节。 该数据不可通过任何形式来修改，除非是刚使用 `PyBytes_FromStringAndSize(NULL, size)` 创建该对象。 它不可被撤销分配。 如果 o 根本不是一个字节串对象，则 `PyBytes_AsString()` 将返回 `NULL` 并引发 `TypeError`。

char* `PyBytes_AS_STRING`(PyObject *string)

  宏版本的 `PyBytes_AsString()` 但是不带错误检测。

int `PyBytes_AsStringAndSize`(PyObject *obj, char **buffer, Py_ssize_t *length)

  通过输出变量 buffer 和 length 返回以 null 为终止符的对象 obj 的内容。

  如果 length 为 `NULL`，字节串对象就不包含嵌入的空字节；如果包含，则该函数将返回 `-1` 并引发 `ValueError`。

  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, `PyBytes_AsStringAndSize()` returns `-1` and raises `TypeError`.

  在 3.5 版更改: Previously, `TypeError` was raised when embedded null bytes were encountered in the bytes object.

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.

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.

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`, `MemoryError` is set, and `-1` is returned.