檔案物件¶
這些 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 流有自己的緩衝層,將它們與作業系統級檔案描述符混合使用可能會產生各種問題(例如意外的資料排序)。
在 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
。
-
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*)¶