cpython/Include/fileobject.h

/* File object interface (what's left of it -- see io.py) */

#ifndef Py_FILEOBJECT_H
#define Py_FILEOBJECT_H
#ifdef __cplusplus
extern "C" {
#endif

#define PY_STDIOTEXTMODE "b"

PyAPI_FUNC(PyObject *) PyFile_FromFd(int, const char *, const char *, int,
                                     const char *, const char *,
                                     const char *, int);
PyAPI_FUNC(PyObject *) PyFile_GetLine(PyObject *, int);
PyAPI_FUNC(int) PyFile_WriteObject(PyObject *, PyObject *, int);
PyAPI_FUNC(int) PyFile_WriteString(const char *, PyObject *);
PyAPI_FUNC(int) PyObject_AsFileDescriptor(PyObject *);

/* The default encoding used by the platform file system APIs
   If non-NULL, this is different than the default encoding for strings
*/
Py_DEPRECATED(3.12) PyAPI_DATA(const char *) Py_FileSystemDefaultEncoding;
#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03060000
Py_DEPRECATED(3.12) PyAPI_DATA(const char *) Py_FileSystemDefaultEncodeErrors;
#endif
Py_DEPRECATED(3.12) PyAPI_DATA(int) Py_HasFileSystemDefaultEncoding;

#if !defined(Py_LIMITED_API) || Py_LIMITED_API+0 >= 0x03070000
Py_DEPRECATED(3.12) PyAPI_DATA(int) Py_UTF8Mode;
#endif

#ifndef Py_LIMITED_API
#  define Py_CPYTHON_FILEOBJECT_H
#  include "cpython/fileobject.h"
#  undef Py_CPYTHON_FILEOBJECT_H
#endif

#ifdef __cplusplus
}
#endif
#endif /* !Py_FILEOBJECT_H */
Rip out the file object's implementation. Fixed test_import.py while I was at it. However, there's still a problem in import.c -- get_file() can leak a FILE struct (not a file descriptor though). I'm not sure how to fix this; closing the FILE* closes the file descriptor, and that's the wrong thing to do when there's still a Python file object keeping the file descriptor open. I also would rather not mess with dup(), as it won't port to Windows. 2007-06-12 23:30:11 +00:00			`/* File object interface (what's left of it -- see io.py) */`
Initial revision 1990-10-14 12:07:46 +00:00
ANSI-fication and Py_PROTO extermination. 2000-07-09 00:20:36 +00:00			`#ifndef Py_FILEOBJECT_H`
			`#define Py_FILEOBJECT_H`
			`#ifdef __cplusplus`
			`extern "C" {`
			`#endif`

Rip out the file object's implementation. Fixed test_import.py while I was at it. However, there's still a problem in import.c -- get_file() can leak a FILE struct (not a file descriptor though). I'm not sure how to fix this; closing the FILE* closes the file descriptor, and that's the wrong thing to do when there's still a Python file object keeping the file descriptor open. I also would rather not mess with dup(), as it won't port to Windows. 2007-06-12 23:30:11 +00:00			`#define PY_STDIOTEXTMODE "b"`
Initial revision 1990-10-14 12:07:46 +00:00
Issue #1772673: The type of `char` arguments now changed to `const char`. 2013-10-19 18:03:34 +00:00			`PyAPI_FUNC(PyObject ) PyFile_FromFd(int, const char , const char *, int,`
			`const char , const char ,`
			`const char *, int);`
Excise DL_EXPORT from Include. Thanks to Skip Montanaro and Kalle Svensson for the patches. 2002-08-12 07:21:58 +00:00			`PyAPI_FUNC(PyObject ) PyFile_GetLine(PyObject , int);`
			`PyAPI_FUNC(int) PyFile_WriteObject(PyObject , PyObject , int);`
			`PyAPI_FUNC(int) PyFile_WriteString(const char , PyObject );`
			`PyAPI_FUNC(int) PyObject_AsFileDescriptor(PyObject *);`
* Added support for X11 modules. * Makefile: change location of FORMS library. * posixmodule.c: turn #if 0 into #ifdef MSDOS (stuff in unistd.h or not) * Almost all .h files: added CPP magic to avoid duplicate inclusions and to support inclusion from C++. 1993-07-28 09:05:47 +00:00
Fix the Py_FileSystemDefaultEncoding checkin - declare the variable in a fileobject.h, and initialize it in bltinmodule. 2001-05-14 12:17:34 +00:00			`/* The default encoding used by the platform file system APIs`
Py_UniversalNewlineFread(): Many changes. + Continued looping until n bytes in the buffer have been filled, not just when n bytes have been read from the file. This repairs the bug that f.readlines() only sucked up the first 8192 bytes of the file on Windows when universal newlines was enabled and f was opened in U mode (see Python-Dev -- this was the ultimate cause of the test_inspect.py failure). + Changed prototye to take a char* buffer (void* doesn't make much sense). + Squashed size_t vs int mismatches (in particular, besides the unsigned vs signed distinction, size_t may be larger than int). + Gets out under all error conditions now (it's possible for fread() to suffer an error even if it returns a number larger than 0 -- any "short read" is an error or EOF condition). + Rearranged and simplified declarations. 2002-04-21 07:29:14 +00:00			`If non-NULL, this is different than the default encoding for strings`
Fix the Py_FileSystemDefaultEncoding checkin - declare the variable in a fileobject.h, and initialize it in bltinmodule. 2001-05-14 12:17:34 +00:00			`*/`
gh-77782: Deprecate global configuration variable (#93943) Deprecate global configuration variable like Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be instead. Fix declaration of Py_GETENV(): use PyAPI_FUNC(), not PyAPI_DATA(). 2022-06-17 14:12:00 +00:00			`Py_DEPRECATED(3.12) PyAPI_DATA(const char *) Py_FileSystemDefaultEncoding;`
bpo-41986: Add Py_FileSystemDefaultEncodeErrors and Py_UTF8Mode back to limited API (GH-22621) 2020-10-10 14:09:45 +00:00			`#if !defined(Py_LIMITED_API) \|\| Py_LIMITED_API+0 >= 0x03060000`
gh-77782: Deprecate global configuration variable (#93943) Deprecate global configuration variable like Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be instead. Fix declaration of Py_GETENV(): use PyAPI_FUNC(), not PyAPI_DATA(). 2022-06-17 14:12:00 +00:00			`Py_DEPRECATED(3.12) PyAPI_DATA(const char *) Py_FileSystemDefaultEncodeErrors;`
bpo-41986: Add Py_FileSystemDefaultEncodeErrors and Py_UTF8Mode back to limited API (GH-22621) 2020-10-10 14:09:45 +00:00			`#endif`
gh-77782: Deprecate Py_HasFileSystemDefaultEncoding (#106272) Deprecate Py_HasFileSystemDefaultEncoding variable. 2023-06-30 09:57:06 +00:00			`Py_DEPRECATED(3.12) PyAPI_DATA(int) Py_HasFileSystemDefaultEncoding;`
Fix the Py_FileSystemDefaultEncoding checkin - declare the variable in a fileobject.h, and initialize it in bltinmodule. 2001-05-14 12:17:34 +00:00
bpo-41986: Add Py_FileSystemDefaultEncodeErrors and Py_UTF8Mode back to limited API (GH-22621) 2020-10-10 14:09:45 +00:00			`#if !defined(Py_LIMITED_API) \|\| Py_LIMITED_API+0 >= 0x03070000`
gh-77782: Deprecate global configuration variable (#93943) Deprecate global configuration variable like Py_IgnoreEnvironmentFlag: the Py_InitializeFromConfig() API should be instead. Fix declaration of Py_GETENV(): use PyAPI_FUNC(), not PyAPI_DATA(). 2022-06-17 14:12:00 +00:00			`Py_DEPRECATED(3.12) PyAPI_DATA(int) Py_UTF8Mode;`
bpo-41986: Add Py_FileSystemDefaultEncodeErrors and Py_UTF8Mode back to limited API (GH-22621) 2020-10-10 14:09:45 +00:00			`#endif`

bpo-36842: Implement PEP 578 (GH-12613) Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs. 2019-05-23 15:45:22 +00:00			`#ifndef Py_LIMITED_API`
			`# define Py_CPYTHON_FILEOBJECT_H`
bpo-45434: Remove useless space in includes (GH-28963) Micro-optimize spaces! 2021-10-14 23:50:04 +00:00			`# include "cpython/fileobject.h"`
bpo-36842: Implement PEP 578 (GH-12613) Adds sys.audit, sys.addaudithook, io.open_code, and associated C APIs. 2019-05-23 15:45:22 +00:00			`# undef Py_CPYTHON_FILEOBJECT_H`
			`#endif`

* Added support for X11 modules. * Makefile: change location of FORMS library. * posixmodule.c: turn #if 0 into #ifdef MSDOS (stuff in unistd.h or not) * Almost all .h files: added CPP magic to avoid duplicate inclusions and to support inclusion from C++. 1993-07-28 09:05:47 +00:00			`#ifdef __cplusplus`
			`}`
			`#endif`
			`#endif /* !Py_FILEOBJECT_H */`