文件对象

这些 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 文件对象。参数 nameencodingerrorsnewline 可以是 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() 方法的任何对象。如果 n0,则读取一行,无论该行的长度如何。如果 n 大于 0,则从文件中读取的字节数不会超过 n;可以返回部分行。在这两种情况下,如果立即到达文件末尾,则返回空字符串。但是,如果 n 小于 0,则无论长度如何都读取一行,但如果立即到达文件末尾,则会引发 EOFError

int PyFile_SetOpenCodeHook(Py_OpenCodeHookFunction handler)

覆盖 io.open_code() 的正常行为,以通过提供的处理程序传递其参数。

处理程序是类型函数

type Py_OpenCodeHookFunction

相当于 PyObject *(*)(PyObject *path, void *userData),其中保证 pathPyUnicodeObject

userData 指针传递到挂钩函数中。由于挂钩函数可以从不同的运行时调用,因此此指针不应直接引用 Python 状态。

由于此挂钩在导入期间故意使用,因此请避免在其执行期间导入新模块,除非已知它们已冻结或在 sys.modules 中可用。

一旦设置了挂钩,就无法将其删除或替换,以后对 PyFile_SetOpenCodeHook() 的调用将失败。如果失败,该函数将返回 -1,并在解释器已初始化的情况下设置异常。

此函数在 Py_Initialize() 之前调用是安全的。

引发 审核事件 setopencodehook,无参数。

在 3.8 版本中添加。

int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)
稳定 ABI 的一部分。

将对象 obj 写入文件对象 pflags 唯一支持的标志是 Py_PRINT_RAW;如果给出,则写入对象的 str(),而不是 repr()。成功时返回 0,失败时返回 -1;将设置适当的异常。

int PyFile_WriteString(const char *s, PyObject *p)
稳定 ABI 的一部分。

将字符串 s 写入文件对象 p。成功时返回 0,失败时返回 -1;将设置适当的异常。