文件对象 — Python 文档

来自菜鸟教程
Python/docs/3.10/c-api/file
跳转至:导航、​搜索

文件对象

这些 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)

从已经打开的文件 fd 的文件描述符创建一个 Python 文件对象。 参数 nameencodingerrorsnewline 可以是 NULL 以使用默认值; buffering可以是-1使用默认值。 name 被忽略并保留以实现向后兼容性。 失败时返回 NULL。 有关参数的更全面描述,请参阅 io.open() 函数文档。

警告

由于 Python 流有自己的缓冲层,将它们与操作系统级文件描述符混合会产生各种问题(例如数据的意外排序)。

3.2 版更改:忽略 name 属性。

int PyObject_AsFileDescriptor(PyObject *p)
将与 p 关联的文件描述符作为 int 返回。 如果对象是整数,则返回其值。 如果不存在,则调用对象的 fileno() 方法(如果存在); 该方法必须返回一个整数,该整数作为文件描述符值返回。 设置异常并在失败时返回 -1
PyObject *PyFile_GetLine(PyObject *p, int n)
相当于p.readline([n]),该函数从对象p读取一行。 p 可以是文件对象或任何具有 readline() 方法的对象。 如果 n0,则无论行的长度如何,都只读取一行。 如果n大于0,则从文件中读取不超过n个字节; 可以返回部分行。 在这两种情况下,如果立即到达文件末尾,则返回空字符串。 但是,如果 n 小于 0,则无论长度如何都会读取一行,但如果立即到达文件末尾,则会引发 EOFError
int PyFile_SetOpenCodeHook(Py_OpenCodeHookFunction handler)

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

处理程序是 PyObject *(*)(PyObject *path, void *userData) 类型的函数,其中 path 保证为 PyUnicodeObject

userData 指针被传递到钩子函数中。 由于钩子函数可以从不同的运行时调用,这个指针不应该直接指向 Python 状态。

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

一旦设置了钩子,就不能删除或替换它,以后对 PyFile_SetOpenCodeHook() 的调用将失败。 失败时,如果解释器已初始化,则函数返回 -1 并设置异常。

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

3.8 版中的新功能。

int PyFile_WriteObject(PyObject *obj, PyObject *p, int flags)
将对象 obj 写入文件对象 pflags 唯一支持的标志是 Py_PRINT_RAW; 如果给定,则写入对象的 str() 而不是 repr()。 成功返回 0,失败返回 -1; 将设置适当的例外。
int PyFile_WriteString(const char *s, PyObject *p)
将字符串 s 写入文件对象 p。 成功返回 0,失败返回 -1; 将设置适当的例外。