檔案物件¶
這些 API 是對 Python 2 C API 中內建檔案物件的最小模擬,該 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
。
-
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*)¶