檔案物件 (File Objects)¶
這些 API 是用於內建檔案物件的 Python 2 C API 的最小模擬 (minimal emulation)，它過去依賴於 C 標準函式庫對於緩衝 I/O (FILE*) 的支援。在 Python 3 中，檔案和串流使用新的io 模組，它在作業系統的低階無緩衝 I/O 上定義了多個層級。下面描述的函式是這些新 API 的便捷 C 包裝器，主要用於直譯器中的內部錯誤報告；建議第三方程式碼改為存取io API。
- PyObject*PyFile_FromFd(intfd,constchar*name,constchar*mode,intbuffering,constchar*encoding,constchar*errors,constchar*newline,intclosefd)¶
- 回傳值：新的參照。 為穩定 ABI 的一部分.
從已打開檔案fd 的檔案描述器建立一個 Python 檔案物件。引數name、encoding、errors 和newline 可以為
NULL以使用預設值；buffering 可以是-1 以使用預設值。name 被忽略並保留以實作向後相容性。失敗時回傳NULL。有關引數的更全面描述，請參閱io.open()函式文件。警告
由於 Python 串流有自己的緩衝層，將它們與作業系統層級檔案描述器混合使用會產生各種問題（例如資料的排序不符合預期）。
在 3.2 版的變更:忽略name 屬性。
- intPyObject_AsFileDescriptor(PyObject*p)¶
- 為穩定 ABI 的一部分.
回傳與p 關聯的檔案描述器作為int。如果物件是整數，則回傳其值。如果不是整數，則呼叫物件的
fileno()方法（如果存在）；該方法必須回傳一個整數，它作為檔案描述器值回傳。設定例外並在失敗時回傳-1。
- PyObject*PyFile_GetLine(PyObject*p,intn)¶
- 回傳值：新的參照。 為穩定 ABI 的一部分.
相當於
p.readline([n])，這個函式從物件p 中讀取一行。p 可以是檔案物件或任何具有readline()方法的物件。如果n 為0，則不管該行的長度都只會讀取一行。如果n 大於0，則不會從檔案中讀取超過n 個位元組；可以回傳該行的一部分。在這兩種情況下，如果立即到達檔案末尾，則回傳一個空字串。但是，如果n 小於0，無論長度如何，都會讀取一行，但如果立即到達檔案末尾，則會引發EOFError。
- intPyFile_SetOpenCodeHook(Py_OpenCodeHookFunctionhandler)¶
覆蓋
io.open_code()的正常行為以透過提供的處理程式 (handler) 傳遞其參數。handler 是以下類型的函式：
- typedefPyObject*(*Py_OpenCodeHookFunction)(PyObject*,void*)¶
相當於PyObject*(*)(PyObject*path,void*userData)，其中path 保證為
PyUnicodeObject。
userData 指標被傳遞到掛鉤函式 (hook function) 中。由於可能會從不同的執行環境 (runtime) 呼叫掛鉤函式，因此該指標不應直接指向 Python 狀態。
由於此掛鉤函式是在導入期間有意使用的，因此請避免在其執行期間導入新模組，除非它們已知有被凍結或在
sys.modules中可用。一旦設定了一個掛鉤函式，它就不能被刪除或替換，且後續對
PyFile_SetOpenCodeHook()的呼叫將會失敗。失敗時，函式回傳 -1 且若直譯器已初始化便會設定例外。在
Py_Initialize()之前呼叫此函式是安全的。不帶引數地引發一個稽核事件 (auditing event)
setopencodehook。在 3.8 版被加入.
- typedefPyObject*(*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(constchar*path)¶
類似於
PyFile_OpenCodeObject()，但path 是 UTF-8 編碼的constchar*。在 3.8 版被加入.
- intPyFile_WriteObject(PyObject*obj,PyObject*p,intflags)¶
- 為穩定 ABI 的一部分.
將物件obj 寫入檔案物件p。flags 唯一支援的旗標是
Py_PRINT_RAW；如果有給定，則寫入物件的str()而不是repr()。在成功回傳0或在失敗回傳-1；將設定適當的例外。
- intPyFile_WriteString(constchar*s,PyObject*p)¶
- 為穩定 ABI 的一部分.
寫入字串s 到 檔案物件p。當成功時回傳 0，而當失敗時回傳 -1，並會設定合適的例外狀況。