Debian Codegraph @

Modules/_io/clinic/_iomodule.c.h

raw
1 /*[clinic input]
2 preserve
3 [clinic start generated code]*/
4
5 #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
6 # include "pycore_gc.h" // PyGC_Head
7 # include "pycore_runtime.h" // _Py_ID()
8 #endif
9 #include "pycore_modsupport.h" // _PyArg_UnpackKeywords()
10
11 PyDoc_STRVAR(_io_open__doc__,
12 "open($module, /, file, mode=\'r\', buffering=-1, encoding=None,\n"
13 " errors=None, newline=None, closefd=True, opener=None)\n"
14 "--\n"
15 "\n"
16 "Open file and return a stream. Raise OSError upon failure.\n"
17 "\n"
18 "file is either a text or byte string giving the name (and the path\n"
19 "if the file isn\'t in the current working directory) of the file to\n"
20 "be opened or an integer file descriptor of the file to be\n"
21 "wrapped. (If a file descriptor is given, it is closed when the\n"
22 "returned I/O object is closed, unless closefd is set to False.)\n"
23 "\n"
24 "mode is an optional string that specifies the mode in which the file\n"
25 "is opened. It defaults to \'r\' which means open for reading in text\n"
26 "mode. Other common values are \'w\' for writing (truncating the file if\n"
27 "it already exists), \'x\' for creating and writing to a new file, and\n"
28 "\'a\' for appending (which on some Unix systems, means that all writes\n"
29 "append to the end of the file regardless of the current seek position).\n"
30 "In text mode, if encoding is not specified the encoding used is platform\n"
31 "dependent: locale.getencoding() is called to get the current locale encoding.\n"
32 "(For reading and writing raw bytes use binary mode and leave encoding\n"
33 "unspecified.) The available modes are:\n"
34 "\n"
35 "========= ===============================================================\n"
36 "Character Meaning\n"
37 "--------- ---------------------------------------------------------------\n"
38 "\'r\' open for reading (default)\n"
39 "\'w\' open for writing, truncating the file first\n"
40 "\'x\' create a new file and open it for writing\n"
41 "\'a\' open for writing, appending to the end of the file if it exists\n"
42 "\'b\' binary mode\n"
43 "\'t\' text mode (default)\n"
44 "\'+\' open a disk file for updating (reading and writing)\n"
45 "========= ===============================================================\n"
46 "\n"
47 "The default mode is \'rt\' (open for reading text). For binary random\n"
48 "access, the mode \'w+b\' opens and truncates the file to 0 bytes, while\n"
49 "\'r+b\' opens the file without truncation. The \'x\' mode implies \'w\' and\n"
50 "raises an `FileExistsError` if the file already exists.\n"
51 "\n"
52 "Python distinguishes between files opened in binary and text modes,\n"
53 "even when the underlying operating system doesn\'t. Files opened in\n"
54 "binary mode (appending \'b\' to the mode argument) return contents as\n"
55 "bytes objects without any decoding. In text mode (the default, or when\n"
56 "\'t\' is appended to the mode argument), the contents of the file are\n"
57 "returned as strings, the bytes having been first decoded using a\n"
58 "platform-dependent encoding or using the specified encoding if given.\n"
59 "\n"
60 "buffering is an optional integer used to set the buffering policy.\n"
61 "Pass 0 to switch buffering off (only allowed in binary mode), 1 to select\n"
62 "line buffering (only usable in text mode), and an integer > 1 to indicate\n"
63 "the size of a fixed-size chunk buffer. When no buffering argument is\n"
64 "given, the default buffering policy works as follows:\n"
65 "\n"
66 "* Binary files are buffered in fixed-size chunks; the size of the buffer\n"
67 " is max(min(blocksize, 8 MiB), DEFAULT_BUFFER_SIZE)\n"
68 " when the device block size is available.\n"
69 " On most systems, the buffer will typically be 128 kilobytes long.\n"
70 "\n"
71 "* \"Interactive\" text files (files for which isatty() returns True)\n"
72 " use line buffering. Other text files use the policy described above\n"
73 " for binary files.\n"
74 "\n"
75 "encoding is the name of the encoding used to decode or encode the\n"
76 "file. This should only be used in text mode. The default encoding is\n"
77 "platform dependent, but any encoding supported by Python can be\n"
78 "passed. See the codecs module for the list of supported encodings.\n"
79 "\n"
80 "errors is an optional string that specifies how encoding errors are to\n"
81 "be handled---this argument should not be used in binary mode. Pass\n"
82 "\'strict\' to raise a ValueError exception if there is an encoding error\n"
83 "(the default of None has the same effect), or pass \'ignore\' to ignore\n"
84 "errors. (Note that ignoring encoding errors can lead to data loss.)\n"
85 "See the documentation for codecs.register or run \'help(codecs.Codec)\'\n"
86 "for a list of the permitted encoding error strings.\n"
87 "\n"
88 "newline controls how universal newlines works (it only applies to text\n"
89 "mode). It can be None, \'\', \'\\n\', \'\\r\', and \'\\r\\n\'. It works as\n"
90 "follows:\n"
91 "\n"
92 "* On input, if newline is None, universal newlines mode is\n"
93 " enabled. Lines in the input can end in \'\\n\', \'\\r\', or \'\\r\\n\', and\n"
94 " these are translated into \'\\n\' before being returned to the\n"
95 " caller. If it is \'\', universal newline mode is enabled, but line\n"
96 " endings are returned to the caller untranslated. If it has any of\n"
97 " the other legal values, input lines are only terminated by the given\n"
98 " string, and the line ending is returned to the caller untranslated.\n"
99 "\n"
100 "* On output, if newline is None, any \'\\n\' characters written are\n"
101 " translated to the system default line separator, os.linesep. If\n"
102 " newline is \'\' or \'\\n\', no translation takes place. If newline is any\n"
103 " of the other legal values, any \'\\n\' characters written are translated\n"
104 " to the given string.\n"
105 "\n"
106 "If closefd is False, the underlying file descriptor will be kept open\n"
107 "when the file is closed. This does not work when a file name is given\n"
108 "and must be True in that case.\n"
109 "\n"
110 "A custom opener can be used by passing a callable as *opener*. The\n"
111 "underlying file descriptor for the file object is then obtained by\n"
112 "calling *opener* with (*file*, *flags*). *opener* must return an open\n"
113 "file descriptor (passing os.open as *opener* results in functionality\n"
114 "similar to passing None).\n"
115 "\n"
116 "open() returns a file object whose type depends on the mode, and\n"
117 "through which the standard file operations such as reading and writing\n"
118 "are performed. When open() is used to open a file in a text mode (\'w\',\n"
119 "\'r\', \'wt\', \'rt\', etc.), it returns a TextIOWrapper. When used to open\n"
120 "a file in a binary mode, the returned class varies: in read binary\n"
121 "mode, it returns a BufferedReader; in write binary and append binary\n"
122 "modes, it returns a BufferedWriter, and in read/write mode, it returns\n"
123 "a BufferedRandom.\n"
124 "\n"
125 "It is also possible to use a string or bytearray as a file for both\n"
126 "reading and writing. For strings StringIO can be used like a file\n"
127 "opened in a text mode, and for bytes a BytesIO can be used like a file\n"
128 "opened in a binary mode.");
129
130 #define _IO_OPEN_METHODDEF \
131 {"open", _PyCFunction_CAST(_io_open), METH_FASTCALL|METH_KEYWORDS, _io_open__doc__},
132
133 static PyObject *
134 _io_open_impl(PyObject *module, PyObject *file, const char *mode,
135 int buffering, const char *encoding, const char *errors,
136 const char *newline, int closefd, PyObject *opener);
137
138 static PyObject *
139 _io_open(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
140 {
141 PyObject *return_value = NULL;
142 #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
143
144 #define NUM_KEYWORDS 8
145 static struct {
146 PyGC_Head _this_is_not_used;
147 PyObject_VAR_HEAD
148 Py_hash_t ob_hash;
149 PyObject *ob_item[NUM_KEYWORDS];
150 } _kwtuple = {
151 .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
152 .ob_hash = -1,
153 .ob_item = { &_Py_ID(file), &_Py_ID(mode), &_Py_ID(buffering), &_Py_ID(encoding), &_Py_ID(errors), &_Py_ID(newline), &_Py_ID(closefd), &_Py_ID(opener), },
154 };
155 #undef NUM_KEYWORDS
156 #define KWTUPLE (&_kwtuple.ob_base.ob_base)
157
158 #else // !Py_BUILD_CORE
159 # define KWTUPLE NULL
160 #endif // !Py_BUILD_CORE
161
162 static const char * const _keywords[] = {"file", "mode", "buffering", "encoding", "errors", "newline", "closefd", "opener", NULL};
163 static _PyArg_Parser _parser = {
164 .keywords = _keywords,
165 .fname = "open",
166 .kwtuple = KWTUPLE,
167 };
168 #undef KWTUPLE
169 PyObject *argsbuf[8];
170 Py_ssize_t noptargs = nargs + (kwnames ? PyTuple_GET_SIZE(kwnames) : 0) - 1;
171 PyObject *file;
172 const char *mode = "r";
173 int buffering = -1;
174 const char *encoding = NULL;
175 const char *errors = NULL;
176 const char *newline = NULL;
177 int closefd = 1;
178 PyObject *opener = Py_None;
179
180 args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
181 /*minpos*/ 1, /*maxpos*/ 8, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
182 if (!args) {
183 goto exit;
184 }
185 file = args[0];
186 if (!noptargs) {
187 goto skip_optional_pos;
188 }
189 if (args[1]) {
190 if (!PyUnicode_Check(args[1])) {
191 _PyArg_BadArgument("open", "argument 'mode'", "str", args[1]);
192 goto exit;
193 }
194 Py_ssize_t mode_length;
195 mode = PyUnicode_AsUTF8AndSize(args[1], &mode_length);
196 if (mode == NULL) {
197 goto exit;
198 }
199 if (strlen(mode) != (size_t)mode_length) {
200 PyErr_SetString(PyExc_ValueError, "embedded null character");
201 goto exit;
202 }
203 if (!--noptargs) {
204 goto skip_optional_pos;
205 }
206 }
207 if (args[2]) {
208 buffering = PyLong_AsInt(args[2]);
209 if (buffering == -1 && PyErr_Occurred()) {
210 goto exit;
211 }
212 if (!--noptargs) {
213 goto skip_optional_pos;
214 }
215 }
216 if (args[3]) {
217 if (args[3] == Py_None) {
218 encoding = NULL;
219 }
220 else if (PyUnicode_Check(args[3])) {
221 Py_ssize_t encoding_length;
222 encoding = PyUnicode_AsUTF8AndSize(args[3], &encoding_length);
223 if (encoding == NULL) {
224 goto exit;
225 }
226 if (strlen(encoding) != (size_t)encoding_length) {
227 PyErr_SetString(PyExc_ValueError, "embedded null character");
228 goto exit;
229 }
230 }
231 else {
232 _PyArg_BadArgument("open", "argument 'encoding'", "str or None", args[3]);
233 goto exit;
234 }
235 if (!--noptargs) {
236 goto skip_optional_pos;
237 }
238 }
239 if (args[4]) {
240 if (args[4] == Py_None) {
241 errors = NULL;
242 }
243 else if (PyUnicode_Check(args[4])) {
244 Py_ssize_t errors_length;
245 errors = PyUnicode_AsUTF8AndSize(args[4], &errors_length);
246 if (errors == NULL) {
247 goto exit;
248 }
249 if (strlen(errors) != (size_t)errors_length) {
250 PyErr_SetString(PyExc_ValueError, "embedded null character");
251 goto exit;
252 }
253 }
254 else {
255 _PyArg_BadArgument("open", "argument 'errors'", "str or None", args[4]);
256 goto exit;
257 }
258 if (!--noptargs) {
259 goto skip_optional_pos;
260 }
261 }
262 if (args[5]) {
263 if (args[5] == Py_None) {
264 newline = NULL;
265 }
266 else if (PyUnicode_Check(args[5])) {
267 Py_ssize_t newline_length;
268 newline = PyUnicode_AsUTF8AndSize(args[5], &newline_length);
269 if (newline == NULL) {
270 goto exit;
271 }
272 if (strlen(newline) != (size_t)newline_length) {
273 PyErr_SetString(PyExc_ValueError, "embedded null character");
274 goto exit;
275 }
276 }
277 else {
278 _PyArg_BadArgument("open", "argument 'newline'", "str or None", args[5]);
279 goto exit;
280 }
281 if (!--noptargs) {
282 goto skip_optional_pos;
283 }
284 }
285 if (args[6]) {
286 closefd = PyObject_IsTrue(args[6]);
287 if (closefd < 0) {
288 goto exit;
289 }
290 if (!--noptargs) {
291 goto skip_optional_pos;
292 }
293 }
294 opener = args[7];
295 skip_optional_pos:
296 return_value = _io_open_impl(module, file, mode, buffering, encoding, errors, newline, closefd, opener);
297
298 exit:
299 return return_value;
300 }
301
302 PyDoc_STRVAR(_io_text_encoding__doc__,
303 "text_encoding($module, encoding, stacklevel=2, /)\n"
304 "--\n"
305 "\n"
306 "A helper function to choose the text encoding.\n"
307 "\n"
308 "When encoding is not None, this function returns it.\n"
309 "Otherwise, this function returns the default text encoding\n"
310 "(i.e. \"locale\" or \"utf-8\" depends on UTF-8 mode).\n"
311 "\n"
312 "This function emits an EncodingWarning if encoding is None and\n"
313 "sys.flags.warn_default_encoding is true.\n"
314 "\n"
315 "This can be used in APIs with an encoding=None parameter.\n"
316 "However, please consider using encoding=\"utf-8\" for new APIs.");
317
318 #define _IO_TEXT_ENCODING_METHODDEF \
319 {"text_encoding", _PyCFunction_CAST(_io_text_encoding), METH_FASTCALL, _io_text_encoding__doc__},
320
321 static PyObject *
322 _io_text_encoding_impl(PyObject *module, PyObject *encoding, int stacklevel);
323
324 static PyObject *
325 _io_text_encoding(PyObject *module, PyObject *const *args, Py_ssize_t nargs)
326 {
327 PyObject *return_value = NULL;
328 PyObject *encoding;
329 int stacklevel = 2;
330
331 if (!_PyArg_CheckPositional("text_encoding", nargs, 1, 2)) {
332 goto exit;
333 }
334 encoding = args[0];
335 if (nargs < 2) {
336 goto skip_optional;
337 }
338 stacklevel = PyLong_AsInt(args[1]);
339 if (stacklevel == -1 && PyErr_Occurred()) {
340 goto exit;
341 }
342 skip_optional:
343 return_value = _io_text_encoding_impl(module, encoding, stacklevel);
344
345 exit:
346 return return_value;
347 }
348
349 PyDoc_STRVAR(_io_open_code__doc__,
350 "open_code($module, /, path)\n"
351 "--\n"
352 "\n"
353 "Opens the provided file with the intent to import the contents.\n"
354 "\n"
355 "This may perform extra validation beyond open(), but is otherwise interchangeable\n"
356 "with calling open(path, \'rb\').");
357
358 #define _IO_OPEN_CODE_METHODDEF \
359 {"open_code", _PyCFunction_CAST(_io_open_code), METH_FASTCALL|METH_KEYWORDS, _io_open_code__doc__},
360
361 static PyObject *
362 _io_open_code_impl(PyObject *module, PyObject *path);
363
364 static PyObject *
365 _io_open_code(PyObject *module, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
366 {
367 PyObject *return_value = NULL;
368 #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
369
370 #define NUM_KEYWORDS 1
371 static struct {
372 PyGC_Head _this_is_not_used;
373 PyObject_VAR_HEAD
374 Py_hash_t ob_hash;
375 PyObject *ob_item[NUM_KEYWORDS];
376 } _kwtuple = {
377 .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
378 .ob_hash = -1,
379 .ob_item = { &_Py_ID(path), },
380 };
381 #undef NUM_KEYWORDS
382 #define KWTUPLE (&_kwtuple.ob_base.ob_base)
383
384 #else // !Py_BUILD_CORE
385 # define KWTUPLE NULL
386 #endif // !Py_BUILD_CORE
387
388 static const char * const _keywords[] = {"path", NULL};
389 static _PyArg_Parser _parser = {
390 .keywords = _keywords,
391 .fname = "open_code",
392 .kwtuple = KWTUPLE,
393 };
394 #undef KWTUPLE
395 PyObject *argsbuf[1];
396 PyObject *path;
397
398 args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
399 /*minpos*/ 1, /*maxpos*/ 1, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
400 if (!args) {
401 goto exit;
402 }
403 if (!PyUnicode_Check(args[0])) {
404 _PyArg_BadArgument("open_code", "argument 'path'", "str", args[0]);
405 goto exit;
406 }
407 path = args[0];
408 return_value = _io_open_code_impl(module, path);
409
410 exit:
411 return return_value;
412 }
413 /*[clinic end generated code: output=7a8e032c0424bce2 input=a9049054013a1b77]*/