文件对象¶
这些 API 是对内置文件对象的 Python 2 C API 的最小化模拟，它过去依赖于 C 标准库的带缓冲 I/O (FILE*) 支持。在 Python 3 中，文件和流使用新的 io 模块，它在操作系统的低层级无缓冲 I/O 之上定义了几个层。下面介绍的函数是针对这些新 API 的便捷 C 包装器，主要用于解释器的内部错误报告；建议第三方代码改为访问 io API 接口。
-
PyObject *PyFile_FromFd(int fd, const char *name, const char *mode, int buffering, const char *encoding, const char *errors, const char *newline, int closefd)¶
- 返回值：新的引用。 属于 稳定 ABI.
根据已打开文件 fd 的文件描述符创建一个 Python 文件对象。参数 name, encoding, errors 和 newline 可以为
NULL表示使用默认值；buffering 可以为 -1 表示使用默认值。 name 会被忽略仅保留用于向下兼容。失败时返回NULL。有关参数的更全面描述，请参阅io.open()函数的文档。警告
由于 Python 流具有自己的缓冲层，因此将它们与 OS 级文件描述符混合会产生各种问题（例如数据的意外排序）。
在 3.2 版本发生变更: 忽略 name 属性。
-
int PyObject_AsFileDescriptor(PyObject *p)¶
- 属于 稳定 ABI.
将与 p 关联的文件描述符作为 int 返回。如果对象是整数，则返回其值。如果不是，则如果对象存在
fileno()方法则调用该方法；该方法必须返回一个整数，它将作为文件描述符的值返回。失败时将设置异常并返回-1。
-
PyObject *PyFile_GetLine(PyObject *p, int n)¶
- 返回值：新的引用。 属于 稳定 ABI.
等价于
p.readline([n])，这个函数从对象 p 中读取一行。 p 可以是文件对象或具有readline()方法的任何对象。如果 n 是0，则无论该行的长度如何，都会读取一行。如果 n 大于0，则从文件中读取不超过 n 个字节；可以返回行的一部分。在这两种情况下，如果立即到达文件末尾，则返回空字符串。但是，如果 n 小于0，则无论长度如何都会读取一行，但是如果立即到达文件末尾，则引发EOFError。
-
char *Py_UniversalNewlineFgets(char *buf, int n, FILE *stream, PyObject *fobj)¶
将来自 C 流 stream 的一行内容读取到缓冲区 buf 中，类似于 C 标准库函数
fgets()的实现方式，但将\n、\r和\r\n全部视为行尾（参见 universal newlines）；从该流中读取的任何\r或\r\n内容，都会以单个\n的形式存储在 buf 中。最多可存储
n - 1个字符到 buf 中；在存储完换行符或到达文件末尾后，读取操作即停止。结果始终以空字符结尾。stream 应以二进制模式打开，这样 C 库就不会自行执行换行符转换。成功时返回 buf；若无法读取任何字符，则返回
NULL，因为 stream 已到达文件末尾、发生了读取错误，或 n 小于 2。与fgets()类似，此函数不会区分文件末尾与读取错误，也不会设置异常。fobj 仅用于向后兼容，且必须为
NULL。
-
int PyFile_SetOpenCodeHook(Py_OpenCodeHookFunction handler)¶
重写
io.open_code()的正常行为，将其形参通过所提供的处理程序来传递。handler 函数的类型为：
-
typedef PyObject *(*Py_OpenCodeHookFunction)(PyObject*, void*)¶
等价于 PyObject *(*)(PyObject *path, void *userData)，其中 path 会确保为
PyUnicodeObject类型对象。
userData 指针会被传入钩子函数。由于钩子函数可能由不同的运行时调用，该指针不应直接指向 Python 状态。
鉴于这个钩子是在导入期间有意使用的，请避免在其执行期间导入新模块，除非已知它们为冻结状态或者是在
sys.modules中可用。一旦钩子被设定，它就不能被移除或替换，之后对
PyFile_SetOpenCodeHook()的调用也将失败，如果解释器已经被初始化，函数将返回 -1 并设置一个异常。此函数可以安全地在
Py_Initialize()之前调用。引发一个不带参数的 审计事件
setopencodehook。在 3.8 版本加入.
-
typedef PyObject *(*Py_OpenCodeHookFunction)(PyObject*, void*)¶
-
PyObject *PyFile_OpenCodeObject(PyObject *path)¶
使用
'rb'模式打开 path。 path 必须是一个 Pythonstr对象。此函数的行为可能被PyFile_SetOpenCodeHook()重写以允许对文本进行某些预处理。这对应于 Python 中的
io.open_code()。成功时，此函数将返回一个指向 Python 文件对象的 strong reference。失败时，此函数将返回
NULL并设置一个异常。在 3.8 版本加入.
-
PyObject *PyFile_OpenCode(const char *path)¶
类似于
PyFile_OpenCodeObject()，但 path 是一个 UTF-8 编码的 const char* 字符串。在 3.8 版本加入.
-
int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)¶
- 属于 稳定 ABI.
将对象 obj 写入文件对象 p。 flags 唯一支持的旗标是
Py_PRINT_RAW；如果给出，则会写入对象的str()而不是repr()。如果 obj 为
NULL，则写入字符串"<NULL>"。成功时返回
0，失败时返回-1；将设置相应的异常。
-
int PyFile_WriteString(const char *s, PyObject *p)¶
- 属于 稳定 ABI.
将字符串 s 写入文件对象 p。成功返回
0失败返回-1；将设定相应的异常。
已被软弃用的 API¶
这些 API 是 Python 的 C API 中因误操作而包含在内的。它们仅出于完整性考虑而提供文档；请改用其他 PyFile* API。
-
PyObject *PyFile_NewStdPrinter(int fd)¶
请改用
PyFile_FromFd()并保持默认值 (fd, NULL, "w", -1, NULL, NULL, NULL, 0)。自 3.15 版起已处于 Soft deprecated 状态.
-
PyTypeObject PyStdPrinter_Type¶
在 Python 启动期间当
io尚不可用时内部使用的文件型对象的类型。请改用 Pythonopen()或PyFile_FromFd()来创建文件对象。自 3.15 版起已处于 Soft deprecated 状态.
-
PY_STDIOTEXTMODE¶
字符串常量
"b"用于以二进制模式打开文件。仅出于向后兼容目的而公开。自 3.15.2 版起已处于 Soft deprecated 状态.