Skip Montanaro | a16b21f | 2003-03-23 14:32:54 +0000 | [diff] [blame] | 1 | /* csv module */ |
| 2 | |
| 3 | /* |
| 4 | |
| 5 | This module provides the low-level underpinnings of a CSV reading/writing |
| 6 | module. Users should not use this module directly, but import the csv.py |
| 7 | module instead. |
| 8 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 9 | */ |
| 10 | |
Skip Montanaro | 7b01a83 | 2003-04-12 19:23:46 +0000 | [diff] [blame] | 11 | #define MODULE_VERSION "1.0" |
| 12 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 13 | #include "Python.h" |
Victor Stinner | 4a21e57 | 2020-04-15 02:35:41 +0200 | [diff] [blame] | 14 | #include "structmember.h" // PyMemberDef |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 15 | #include <stdbool.h> |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 16 | |
Andrew McNamara | 37d2bdf | 2005-01-10 12:22:48 +0000 | [diff] [blame] | 17 | |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 18 | typedef struct { |
| 19 | PyObject *error_obj; /* CSV exception */ |
| 20 | PyObject *dialects; /* Dialect registry */ |
| 21 | long field_limit; /* max parsed field size */ |
| 22 | } _csvstate; |
| 23 | |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 24 | static inline _csvstate* |
| 25 | get_csv_state(PyObject *module) |
| 26 | { |
| 27 | void *state = PyModule_GetState(module); |
| 28 | assert(state != NULL); |
| 29 | return (_csvstate *)state; |
| 30 | } |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 31 | |
| 32 | static int |
| 33 | _csv_clear(PyObject *m) |
| 34 | { |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 35 | Py_CLEAR(get_csv_state(m)->error_obj); |
| 36 | Py_CLEAR(get_csv_state(m)->dialects); |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 37 | return 0; |
| 38 | } |
| 39 | |
| 40 | static int |
| 41 | _csv_traverse(PyObject *m, visitproc visit, void *arg) |
| 42 | { |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 43 | Py_VISIT(get_csv_state(m)->error_obj); |
| 44 | Py_VISIT(get_csv_state(m)->dialects); |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 45 | return 0; |
| 46 | } |
| 47 | |
| 48 | static void |
| 49 | _csv_free(void *m) |
| 50 | { |
| 51 | _csv_clear((PyObject *)m); |
| 52 | } |
| 53 | |
| 54 | static struct PyModuleDef _csvmodule; |
| 55 | |
| 56 | #define _csvstate_global ((_csvstate *)PyModule_GetState(PyState_FindModule(&_csvmodule))) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 57 | |
| 58 | typedef enum { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 59 | START_RECORD, START_FIELD, ESCAPED_CHAR, IN_FIELD, |
| 60 | IN_QUOTED_FIELD, ESCAPE_IN_QUOTED_FIELD, QUOTE_IN_QUOTED_FIELD, |
R David Murray | c7c42ef | 2013-03-19 22:41:47 -0400 | [diff] [blame] | 61 | EAT_CRNL,AFTER_ESCAPED_CRNL |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 62 | } ParserState; |
| 63 | |
| 64 | typedef enum { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 65 | QUOTE_MINIMAL, QUOTE_ALL, QUOTE_NONNUMERIC, QUOTE_NONE |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 66 | } QuoteStyle; |
| 67 | |
| 68 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 69 | QuoteStyle style; |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 70 | const char *name; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 71 | } StyleDesc; |
| 72 | |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 73 | static const StyleDesc quote_styles[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 74 | { QUOTE_MINIMAL, "QUOTE_MINIMAL" }, |
| 75 | { QUOTE_ALL, "QUOTE_ALL" }, |
| 76 | { QUOTE_NONNUMERIC, "QUOTE_NONNUMERIC" }, |
| 77 | { QUOTE_NONE, "QUOTE_NONE" }, |
| 78 | { 0 } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 79 | }; |
| 80 | |
| 81 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 82 | PyObject_HEAD |
Guido van Rossum | 4626458 | 2007-08-06 19:32:18 +0000 | [diff] [blame] | 83 | |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 84 | char doublequote; /* is " represented by ""? */ |
| 85 | char skipinitialspace; /* ignore spaces following delimiter? */ |
| 86 | char strict; /* raise exception on bad CSV */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 87 | int quoting; /* style of quoting to write */ |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 88 | Py_UCS4 delimiter; /* field separator */ |
| 89 | Py_UCS4 quotechar; /* quote character */ |
| 90 | Py_UCS4 escapechar; /* escape character */ |
| 91 | PyObject *lineterminator; /* string to write between records */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 92 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 93 | } DialectObj; |
| 94 | |
Neal Norwitz | 227b533 | 2006-03-22 09:28:35 +0000 | [diff] [blame] | 95 | static PyTypeObject Dialect_Type; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 96 | |
| 97 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 98 | PyObject_HEAD |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 99 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 100 | PyObject *input_iter; /* iterate over this for input lines */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 101 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 102 | DialectObj *dialect; /* parsing dialect */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 103 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 104 | PyObject *fields; /* field list for current record */ |
| 105 | ParserState state; /* current CSV parse state */ |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 106 | Py_UCS4 *field; /* temporary buffer */ |
Antoine Pitrou | 4045575 | 2010-08-15 18:51:10 +0000 | [diff] [blame] | 107 | Py_ssize_t field_size; /* size of allocated buffer */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 108 | Py_ssize_t field_len; /* length of current field */ |
| 109 | int numeric_field; /* treat field as numeric */ |
| 110 | unsigned long line_num; /* Source-file line number */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 111 | } ReaderObj; |
| 112 | |
Neal Norwitz | 227b533 | 2006-03-22 09:28:35 +0000 | [diff] [blame] | 113 | static PyTypeObject Reader_Type; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 114 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 115 | typedef struct { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 116 | PyObject_HEAD |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 117 | |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 118 | PyObject *write; /* write output lines to this file */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 119 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 120 | DialectObj *dialect; /* parsing dialect */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 121 | |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 122 | Py_UCS4 *rec; /* buffer for parser.join */ |
Antoine Pitrou | 4045575 | 2010-08-15 18:51:10 +0000 | [diff] [blame] | 123 | Py_ssize_t rec_size; /* size of allocated record */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 124 | Py_ssize_t rec_len; /* length of record */ |
| 125 | int num_fields; /* number of fields in record */ |
Guido van Rossum | 4626458 | 2007-08-06 19:32:18 +0000 | [diff] [blame] | 126 | } WriterObj; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 127 | |
Neal Norwitz | 227b533 | 2006-03-22 09:28:35 +0000 | [diff] [blame] | 128 | static PyTypeObject Writer_Type; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 129 | |
| 130 | /* |
| 131 | * DIALECT class |
| 132 | */ |
| 133 | |
| 134 | static PyObject * |
| 135 | get_dialect_from_registry(PyObject * name_obj) |
| 136 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 137 | PyObject *dialect_obj; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 138 | |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 139 | dialect_obj = PyDict_GetItemWithError(_csvstate_global->dialects, name_obj); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 140 | if (dialect_obj == NULL) { |
| 141 | if (!PyErr_Occurred()) |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 142 | PyErr_Format(_csvstate_global->error_obj, "unknown dialect"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 143 | } |
| 144 | else |
| 145 | Py_INCREF(dialect_obj); |
| 146 | return dialect_obj; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 147 | } |
| 148 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 149 | static PyObject * |
| 150 | get_string(PyObject *str) |
| 151 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 152 | Py_XINCREF(str); |
| 153 | return str; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 154 | } |
| 155 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 156 | static PyObject * |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 157 | get_nullchar_as_None(Py_UCS4 c) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 158 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 159 | if (c == '\0') { |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 160 | Py_RETURN_NONE; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 161 | } |
| 162 | else |
Martin v. Löwis | d63a3b8 | 2011-09-28 07:41:54 +0200 | [diff] [blame] | 163 | return PyUnicode_FromOrdinal(c); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 164 | } |
| 165 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 166 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 167 | Dialect_get_lineterminator(DialectObj *self, void *Py_UNUSED(ignored)) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 168 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 169 | return get_string(self->lineterminator); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 170 | } |
| 171 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 172 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 173 | Dialect_get_delimiter(DialectObj *self, void *Py_UNUSED(ignored)) |
Guido van Rossum | a9769c2 | 2007-08-07 23:59:30 +0000 | [diff] [blame] | 174 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 175 | return get_nullchar_as_None(self->delimiter); |
Guido van Rossum | a9769c2 | 2007-08-07 23:59:30 +0000 | [diff] [blame] | 176 | } |
| 177 | |
| 178 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 179 | Dialect_get_escapechar(DialectObj *self, void *Py_UNUSED(ignored)) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 180 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 181 | return get_nullchar_as_None(self->escapechar); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 182 | } |
| 183 | |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 184 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 185 | Dialect_get_quotechar(DialectObj *self, void *Py_UNUSED(ignored)) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 186 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 187 | return get_nullchar_as_None(self->quotechar); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 188 | } |
| 189 | |
| 190 | static PyObject * |
Serhiy Storchaka | d4f9cf5 | 2018-11-27 19:34:35 +0200 | [diff] [blame] | 191 | Dialect_get_quoting(DialectObj *self, void *Py_UNUSED(ignored)) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 192 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 193 | return PyLong_FromLong(self->quoting); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 194 | } |
| 195 | |
| 196 | static int |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 197 | _set_bool(const char *name, char *target, PyObject *src, bool dflt) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 198 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 199 | if (src == NULL) |
| 200 | *target = dflt; |
Antoine Pitrou | 6f430e4 | 2012-08-15 23:18:25 +0200 | [diff] [blame] | 201 | else { |
| 202 | int b = PyObject_IsTrue(src); |
| 203 | if (b < 0) |
| 204 | return -1; |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 205 | *target = (char)b; |
Antoine Pitrou | 6f430e4 | 2012-08-15 23:18:25 +0200 | [diff] [blame] | 206 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 207 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 208 | } |
| 209 | |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 210 | static int |
| 211 | _set_int(const char *name, int *target, PyObject *src, int dflt) |
| 212 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 213 | if (src == NULL) |
| 214 | *target = dflt; |
| 215 | else { |
Victor Stinner | 7a6dbb7 | 2016-10-19 16:00:37 +0200 | [diff] [blame] | 216 | int value; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 217 | if (!PyLong_CheckExact(src)) { |
| 218 | PyErr_Format(PyExc_TypeError, |
| 219 | "\"%s\" must be an integer", name); |
| 220 | return -1; |
| 221 | } |
Victor Stinner | 7a6dbb7 | 2016-10-19 16:00:37 +0200 | [diff] [blame] | 222 | value = _PyLong_AsInt(src); |
| 223 | if (value == -1 && PyErr_Occurred()) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 224 | return -1; |
| 225 | } |
Victor Stinner | 7a6dbb7 | 2016-10-19 16:00:37 +0200 | [diff] [blame] | 226 | *target = value; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 227 | } |
| 228 | return 0; |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 229 | } |
| 230 | |
| 231 | static int |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 232 | _set_char(const char *name, Py_UCS4 *target, PyObject *src, Py_UCS4 dflt) |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 233 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 234 | if (src == NULL) |
| 235 | *target = dflt; |
| 236 | else { |
| 237 | *target = '\0'; |
| 238 | if (src != Py_None) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 239 | Py_ssize_t len; |
Serhiy Storchaka | cac23a5 | 2013-12-19 16:27:18 +0200 | [diff] [blame] | 240 | if (!PyUnicode_Check(src)) { |
| 241 | PyErr_Format(PyExc_TypeError, |
| 242 | "\"%s\" must be string, not %.200s", name, |
Victor Stinner | daa9756 | 2020-02-07 03:37:06 +0100 | [diff] [blame] | 243 | Py_TYPE(src)->tp_name); |
Serhiy Storchaka | cac23a5 | 2013-12-19 16:27:18 +0200 | [diff] [blame] | 244 | return -1; |
| 245 | } |
Victor Stinner | 9e30aa5 | 2011-11-21 02:49:52 +0100 | [diff] [blame] | 246 | len = PyUnicode_GetLength(src); |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 247 | if (len > 1) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 248 | PyErr_Format(PyExc_TypeError, |
Berker Peksag | 0f41acb | 2014-07-27 23:22:34 +0300 | [diff] [blame] | 249 | "\"%s\" must be a 1-character string", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 250 | name); |
| 251 | return -1; |
| 252 | } |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 253 | /* PyUnicode_READY() is called in PyUnicode_GetLength() */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 254 | if (len > 0) |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 255 | *target = PyUnicode_READ_CHAR(src, 0); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 256 | } |
| 257 | } |
| 258 | return 0; |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 259 | } |
| 260 | |
| 261 | static int |
| 262 | _set_str(const char *name, PyObject **target, PyObject *src, const char *dflt) |
| 263 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 264 | if (src == NULL) |
| 265 | *target = PyUnicode_DecodeASCII(dflt, strlen(dflt), NULL); |
| 266 | else { |
| 267 | if (src == Py_None) |
| 268 | *target = NULL; |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 269 | else if (!PyUnicode_Check(src)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 270 | PyErr_Format(PyExc_TypeError, |
| 271 | "\"%s\" must be a string", name); |
| 272 | return -1; |
| 273 | } |
| 274 | else { |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 275 | if (PyUnicode_READY(src) == -1) |
| 276 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 277 | Py_INCREF(src); |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 278 | Py_XSETREF(*target, src); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 279 | } |
| 280 | } |
| 281 | return 0; |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 282 | } |
| 283 | |
| 284 | static int |
| 285 | dialect_check_quoting(int quoting) |
| 286 | { |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 287 | const StyleDesc *qs; |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 288 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 289 | for (qs = quote_styles; qs->name; qs++) { |
Victor Stinner | 706768c | 2014-08-16 01:03:39 +0200 | [diff] [blame] | 290 | if ((int)qs->style == quoting) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 291 | return 0; |
| 292 | } |
| 293 | PyErr_Format(PyExc_TypeError, "bad \"quoting\" value"); |
| 294 | return -1; |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 295 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 296 | |
| 297 | #define D_OFF(x) offsetof(DialectObj, x) |
| 298 | |
| 299 | static struct PyMemberDef Dialect_memberlist[] = { |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 300 | { "skipinitialspace", T_BOOL, D_OFF(skipinitialspace), READONLY }, |
| 301 | { "doublequote", T_BOOL, D_OFF(doublequote), READONLY }, |
| 302 | { "strict", T_BOOL, D_OFF(strict), READONLY }, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 303 | { NULL } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 304 | }; |
| 305 | |
| 306 | static PyGetSetDef Dialect_getsetlist[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 307 | { "delimiter", (getter)Dialect_get_delimiter}, |
| 308 | { "escapechar", (getter)Dialect_get_escapechar}, |
| 309 | { "lineterminator", (getter)Dialect_get_lineterminator}, |
| 310 | { "quotechar", (getter)Dialect_get_quotechar}, |
| 311 | { "quoting", (getter)Dialect_get_quoting}, |
| 312 | {NULL}, |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 313 | }; |
| 314 | |
| 315 | static void |
| 316 | Dialect_dealloc(DialectObj *self) |
| 317 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 318 | Py_XDECREF(self->lineterminator); |
| 319 | Py_TYPE(self)->tp_free((PyObject *)self); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 320 | } |
| 321 | |
Martin v. Löwis | 02cbf4a | 2006-02-27 17:20:04 +0000 | [diff] [blame] | 322 | static char *dialect_kws[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 323 | "dialect", |
| 324 | "delimiter", |
| 325 | "doublequote", |
| 326 | "escapechar", |
| 327 | "lineterminator", |
| 328 | "quotechar", |
| 329 | "quoting", |
| 330 | "skipinitialspace", |
| 331 | "strict", |
| 332 | NULL |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 333 | }; |
| 334 | |
Andrew McNamara | 29bf4e4 | 2005-01-11 04:49:53 +0000 | [diff] [blame] | 335 | static PyObject * |
| 336 | dialect_new(PyTypeObject *type, PyObject *args, PyObject *kwargs) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 337 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 338 | DialectObj *self; |
| 339 | PyObject *ret = NULL; |
| 340 | PyObject *dialect = NULL; |
| 341 | PyObject *delimiter = NULL; |
| 342 | PyObject *doublequote = NULL; |
| 343 | PyObject *escapechar = NULL; |
| 344 | PyObject *lineterminator = NULL; |
| 345 | PyObject *quotechar = NULL; |
| 346 | PyObject *quoting = NULL; |
| 347 | PyObject *skipinitialspace = NULL; |
| 348 | PyObject *strict = NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 349 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 350 | if (!PyArg_ParseTupleAndKeywords(args, kwargs, |
| 351 | "|OOOOOOOOO", dialect_kws, |
| 352 | &dialect, |
| 353 | &delimiter, |
| 354 | &doublequote, |
| 355 | &escapechar, |
| 356 | &lineterminator, |
| 357 | "echar, |
| 358 | "ing, |
| 359 | &skipinitialspace, |
| 360 | &strict)) |
| 361 | return NULL; |
Andrew McNamara | 29bf4e4 | 2005-01-11 04:49:53 +0000 | [diff] [blame] | 362 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 363 | if (dialect != NULL) { |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 364 | if (PyUnicode_Check(dialect)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 365 | dialect = get_dialect_from_registry(dialect); |
| 366 | if (dialect == NULL) |
| 367 | return NULL; |
| 368 | } |
| 369 | else |
| 370 | Py_INCREF(dialect); |
| 371 | /* Can we reuse this instance? */ |
| 372 | if (PyObject_TypeCheck(dialect, &Dialect_Type) && |
Serhiy Storchaka | 0b3ec19 | 2017-03-23 17:53:47 +0200 | [diff] [blame] | 373 | delimiter == NULL && |
| 374 | doublequote == NULL && |
| 375 | escapechar == NULL && |
| 376 | lineterminator == NULL && |
| 377 | quotechar == NULL && |
| 378 | quoting == NULL && |
| 379 | skipinitialspace == NULL && |
| 380 | strict == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 381 | return dialect; |
| 382 | } |
Andrew McNamara | 29bf4e4 | 2005-01-11 04:49:53 +0000 | [diff] [blame] | 383 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 384 | self = (DialectObj *)type->tp_alloc(type, 0); |
| 385 | if (self == NULL) { |
| 386 | Py_XDECREF(dialect); |
| 387 | return NULL; |
| 388 | } |
| 389 | self->lineterminator = NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 390 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 391 | Py_XINCREF(delimiter); |
| 392 | Py_XINCREF(doublequote); |
| 393 | Py_XINCREF(escapechar); |
| 394 | Py_XINCREF(lineterminator); |
| 395 | Py_XINCREF(quotechar); |
| 396 | Py_XINCREF(quoting); |
| 397 | Py_XINCREF(skipinitialspace); |
| 398 | Py_XINCREF(strict); |
| 399 | if (dialect != NULL) { |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 400 | #define DIALECT_GETATTR(v, n) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 401 | if (v == NULL) \ |
| 402 | v = PyObject_GetAttrString(dialect, n) |
| 403 | DIALECT_GETATTR(delimiter, "delimiter"); |
| 404 | DIALECT_GETATTR(doublequote, "doublequote"); |
| 405 | DIALECT_GETATTR(escapechar, "escapechar"); |
| 406 | DIALECT_GETATTR(lineterminator, "lineterminator"); |
| 407 | DIALECT_GETATTR(quotechar, "quotechar"); |
| 408 | DIALECT_GETATTR(quoting, "quoting"); |
| 409 | DIALECT_GETATTR(skipinitialspace, "skipinitialspace"); |
| 410 | DIALECT_GETATTR(strict, "strict"); |
| 411 | PyErr_Clear(); |
| 412 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 413 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 414 | /* check types and convert to C values */ |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 415 | #define DIASET(meth, name, target, src, dflt) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 416 | if (meth(name, target, src, dflt)) \ |
| 417 | goto err |
| 418 | DIASET(_set_char, "delimiter", &self->delimiter, delimiter, ','); |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 419 | DIASET(_set_bool, "doublequote", &self->doublequote, doublequote, true); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 420 | DIASET(_set_char, "escapechar", &self->escapechar, escapechar, 0); |
| 421 | DIASET(_set_str, "lineterminator", &self->lineterminator, lineterminator, "\r\n"); |
| 422 | DIASET(_set_char, "quotechar", &self->quotechar, quotechar, '"'); |
| 423 | DIASET(_set_int, "quoting", &self->quoting, quoting, QUOTE_MINIMAL); |
Serhiy Storchaka | 323748a | 2018-07-26 13:21:09 +0300 | [diff] [blame] | 424 | DIASET(_set_bool, "skipinitialspace", &self->skipinitialspace, skipinitialspace, false); |
| 425 | DIASET(_set_bool, "strict", &self->strict, strict, false); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 426 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 427 | /* validate options */ |
| 428 | if (dialect_check_quoting(self->quoting)) |
| 429 | goto err; |
| 430 | if (self->delimiter == 0) { |
Serhiy Storchaka | cac23a5 | 2013-12-19 16:27:18 +0200 | [diff] [blame] | 431 | PyErr_SetString(PyExc_TypeError, |
Berker Peksag | 0f41acb | 2014-07-27 23:22:34 +0300 | [diff] [blame] | 432 | "\"delimiter\" must be a 1-character string"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 433 | goto err; |
| 434 | } |
| 435 | if (quotechar == Py_None && quoting == NULL) |
| 436 | self->quoting = QUOTE_NONE; |
| 437 | if (self->quoting != QUOTE_NONE && self->quotechar == 0) { |
| 438 | PyErr_SetString(PyExc_TypeError, |
| 439 | "quotechar must be set if quoting enabled"); |
| 440 | goto err; |
| 441 | } |
| 442 | if (self->lineterminator == 0) { |
| 443 | PyErr_SetString(PyExc_TypeError, "lineterminator must be set"); |
| 444 | goto err; |
| 445 | } |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 446 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 447 | ret = (PyObject *)self; |
| 448 | Py_INCREF(self); |
Andrew McNamara | 1196cf1 | 2005-01-07 04:42:45 +0000 | [diff] [blame] | 449 | err: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 450 | Py_XDECREF(self); |
| 451 | Py_XDECREF(dialect); |
| 452 | Py_XDECREF(delimiter); |
| 453 | Py_XDECREF(doublequote); |
| 454 | Py_XDECREF(escapechar); |
| 455 | Py_XDECREF(lineterminator); |
| 456 | Py_XDECREF(quotechar); |
| 457 | Py_XDECREF(quoting); |
| 458 | Py_XDECREF(skipinitialspace); |
| 459 | Py_XDECREF(strict); |
| 460 | return ret; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 461 | } |
| 462 | |
| 463 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 464 | PyDoc_STRVAR(Dialect_Type_doc, |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 465 | "CSV dialect\n" |
| 466 | "\n" |
| 467 | "The Dialect type records CSV parsing and generation options.\n"); |
| 468 | |
| 469 | static PyTypeObject Dialect_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 470 | PyVarObject_HEAD_INIT(NULL, 0) |
| 471 | "_csv.Dialect", /* tp_name */ |
| 472 | sizeof(DialectObj), /* tp_basicsize */ |
| 473 | 0, /* tp_itemsize */ |
| 474 | /* methods */ |
| 475 | (destructor)Dialect_dealloc, /* tp_dealloc */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 476 | 0, /* tp_vectorcall_offset */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 477 | (getattrfunc)0, /* tp_getattr */ |
| 478 | (setattrfunc)0, /* tp_setattr */ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 479 | 0, /* tp_as_async */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 480 | (reprfunc)0, /* tp_repr */ |
| 481 | 0, /* tp_as_number */ |
| 482 | 0, /* tp_as_sequence */ |
| 483 | 0, /* tp_as_mapping */ |
| 484 | (hashfunc)0, /* tp_hash */ |
| 485 | (ternaryfunc)0, /* tp_call */ |
| 486 | (reprfunc)0, /* tp_str */ |
| 487 | 0, /* tp_getattro */ |
| 488 | 0, /* tp_setattro */ |
| 489 | 0, /* tp_as_buffer */ |
| 490 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE, /* tp_flags */ |
| 491 | Dialect_Type_doc, /* tp_doc */ |
| 492 | 0, /* tp_traverse */ |
| 493 | 0, /* tp_clear */ |
| 494 | 0, /* tp_richcompare */ |
| 495 | 0, /* tp_weaklistoffset */ |
| 496 | 0, /* tp_iter */ |
| 497 | 0, /* tp_iternext */ |
| 498 | 0, /* tp_methods */ |
| 499 | Dialect_memberlist, /* tp_members */ |
| 500 | Dialect_getsetlist, /* tp_getset */ |
| 501 | 0, /* tp_base */ |
| 502 | 0, /* tp_dict */ |
| 503 | 0, /* tp_descr_get */ |
| 504 | 0, /* tp_descr_set */ |
| 505 | 0, /* tp_dictoffset */ |
| 506 | 0, /* tp_init */ |
| 507 | 0, /* tp_alloc */ |
| 508 | dialect_new, /* tp_new */ |
| 509 | 0, /* tp_free */ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 510 | }; |
| 511 | |
Andrew McNamara | 91b9746 | 2005-01-11 01:07:23 +0000 | [diff] [blame] | 512 | /* |
| 513 | * Return an instance of the dialect type, given a Python instance or kwarg |
| 514 | * description of the dialect |
| 515 | */ |
| 516 | static PyObject * |
| 517 | _call_dialect(PyObject *dialect_inst, PyObject *kwargs) |
| 518 | { |
Victor Stinner | 6412f49 | 2016-08-23 00:21:34 +0200 | [diff] [blame] | 519 | PyObject *type = (PyObject *)&Dialect_Type; |
| 520 | if (dialect_inst) { |
Petr Viktorin | ffd9753 | 2020-02-11 17:46:57 +0100 | [diff] [blame] | 521 | return PyObject_VectorcallDict(type, &dialect_inst, 1, kwargs); |
Victor Stinner | 6412f49 | 2016-08-23 00:21:34 +0200 | [diff] [blame] | 522 | } |
| 523 | else { |
Petr Viktorin | ffd9753 | 2020-02-11 17:46:57 +0100 | [diff] [blame] | 524 | return PyObject_VectorcallDict(type, NULL, 0, kwargs); |
Victor Stinner | 6412f49 | 2016-08-23 00:21:34 +0200 | [diff] [blame] | 525 | } |
Andrew McNamara | 91b9746 | 2005-01-11 01:07:23 +0000 | [diff] [blame] | 526 | } |
| 527 | |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 528 | /* |
| 529 | * READER |
| 530 | */ |
Andrew McNamara | 0f0599d | 2005-01-12 09:45:18 +0000 | [diff] [blame] | 531 | static int |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 532 | parse_save_field(ReaderObj *self) |
| 533 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 534 | PyObject *field; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 535 | |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 536 | field = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, |
| 537 | (void *) self->field, self->field_len); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 538 | if (field == NULL) |
| 539 | return -1; |
| 540 | self->field_len = 0; |
| 541 | if (self->numeric_field) { |
| 542 | PyObject *tmp; |
Andrew McNamara | 0f0599d | 2005-01-12 09:45:18 +0000 | [diff] [blame] | 543 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 544 | self->numeric_field = 0; |
| 545 | tmp = PyNumber_Float(field); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 546 | Py_DECREF(field); |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 547 | if (tmp == NULL) |
| 548 | return -1; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 549 | field = tmp; |
| 550 | } |
Victor Stinner | b80b378 | 2013-11-14 21:29:34 +0100 | [diff] [blame] | 551 | if (PyList_Append(self->fields, field) < 0) { |
| 552 | Py_DECREF(field); |
| 553 | return -1; |
| 554 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 555 | Py_DECREF(field); |
| 556 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 557 | } |
| 558 | |
| 559 | static int |
| 560 | parse_grow_buff(ReaderObj *self) |
| 561 | { |
Sergey Fedoseev | 67b9cc8 | 2018-08-16 09:27:50 +0500 | [diff] [blame] | 562 | assert((size_t)self->field_size <= PY_SSIZE_T_MAX / sizeof(Py_UCS4)); |
| 563 | |
| 564 | Py_ssize_t field_size_new = self->field_size ? 2 * self->field_size : 4096; |
| 565 | Py_UCS4 *field_new = self->field; |
| 566 | PyMem_Resize(field_new, Py_UCS4, field_size_new); |
| 567 | if (field_new == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 568 | PyErr_NoMemory(); |
| 569 | return 0; |
| 570 | } |
Sergey Fedoseev | 67b9cc8 | 2018-08-16 09:27:50 +0500 | [diff] [blame] | 571 | self->field = field_new; |
| 572 | self->field_size = field_size_new; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 573 | return 1; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 574 | } |
| 575 | |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 576 | static int |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 577 | parse_add_char(ReaderObj *self, Py_UCS4 c) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 578 | { |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 579 | if (self->field_len >= _csvstate_global->field_limit) { |
| 580 | PyErr_Format(_csvstate_global->error_obj, "field larger than field limit (%ld)", |
| 581 | _csvstate_global->field_limit); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 582 | return -1; |
| 583 | } |
| 584 | if (self->field_len == self->field_size && !parse_grow_buff(self)) |
| 585 | return -1; |
| 586 | self->field[self->field_len++] = c; |
| 587 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 588 | } |
| 589 | |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 590 | static int |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 591 | parse_process_char(ReaderObj *self, Py_UCS4 c) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 592 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 593 | DialectObj *dialect = self->dialect; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 594 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 595 | switch (self->state) { |
| 596 | case START_RECORD: |
| 597 | /* start of record */ |
| 598 | if (c == '\0') |
| 599 | /* empty line - return [] */ |
| 600 | break; |
| 601 | else if (c == '\n' || c == '\r') { |
| 602 | self->state = EAT_CRNL; |
| 603 | break; |
| 604 | } |
| 605 | /* normal character - handle as START_FIELD */ |
| 606 | self->state = START_FIELD; |
| 607 | /* fallthru */ |
| 608 | case START_FIELD: |
| 609 | /* expecting field */ |
| 610 | if (c == '\n' || c == '\r' || c == '\0') { |
| 611 | /* save empty field - return [fields] */ |
| 612 | if (parse_save_field(self) < 0) |
| 613 | return -1; |
| 614 | self->state = (c == '\0' ? START_RECORD : EAT_CRNL); |
| 615 | } |
| 616 | else if (c == dialect->quotechar && |
| 617 | dialect->quoting != QUOTE_NONE) { |
| 618 | /* start quoted field */ |
| 619 | self->state = IN_QUOTED_FIELD; |
| 620 | } |
| 621 | else if (c == dialect->escapechar) { |
| 622 | /* possible escaped character */ |
| 623 | self->state = ESCAPED_CHAR; |
| 624 | } |
| 625 | else if (c == ' ' && dialect->skipinitialspace) |
| 626 | /* ignore space at start of field */ |
| 627 | ; |
| 628 | else if (c == dialect->delimiter) { |
| 629 | /* save empty field */ |
| 630 | if (parse_save_field(self) < 0) |
| 631 | return -1; |
| 632 | } |
| 633 | else { |
| 634 | /* begin new unquoted field */ |
| 635 | if (dialect->quoting == QUOTE_NONNUMERIC) |
| 636 | self->numeric_field = 1; |
| 637 | if (parse_add_char(self, c) < 0) |
| 638 | return -1; |
| 639 | self->state = IN_FIELD; |
| 640 | } |
| 641 | break; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 642 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 643 | case ESCAPED_CHAR: |
R David Murray | 9a7d376 | 2013-03-20 00:15:20 -0400 | [diff] [blame] | 644 | if (c == '\n' || c=='\r') { |
R David Murray | c7c42ef | 2013-03-19 22:41:47 -0400 | [diff] [blame] | 645 | if (parse_add_char(self, c) < 0) |
| 646 | return -1; |
| 647 | self->state = AFTER_ESCAPED_CRNL; |
| 648 | break; |
| 649 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 650 | if (c == '\0') |
| 651 | c = '\n'; |
| 652 | if (parse_add_char(self, c) < 0) |
| 653 | return -1; |
| 654 | self->state = IN_FIELD; |
| 655 | break; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 656 | |
R David Murray | c7c42ef | 2013-03-19 22:41:47 -0400 | [diff] [blame] | 657 | case AFTER_ESCAPED_CRNL: |
| 658 | if (c == '\0') |
| 659 | break; |
| 660 | /*fallthru*/ |
| 661 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 662 | case IN_FIELD: |
| 663 | /* in unquoted field */ |
| 664 | if (c == '\n' || c == '\r' || c == '\0') { |
| 665 | /* end of line - return [fields] */ |
| 666 | if (parse_save_field(self) < 0) |
| 667 | return -1; |
| 668 | self->state = (c == '\0' ? START_RECORD : EAT_CRNL); |
| 669 | } |
| 670 | else if (c == dialect->escapechar) { |
| 671 | /* possible escaped character */ |
| 672 | self->state = ESCAPED_CHAR; |
| 673 | } |
| 674 | else if (c == dialect->delimiter) { |
| 675 | /* save field - wait for new field */ |
| 676 | if (parse_save_field(self) < 0) |
| 677 | return -1; |
| 678 | self->state = START_FIELD; |
| 679 | } |
| 680 | else { |
| 681 | /* normal character - save in field */ |
| 682 | if (parse_add_char(self, c) < 0) |
| 683 | return -1; |
| 684 | } |
| 685 | break; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 686 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 687 | case IN_QUOTED_FIELD: |
| 688 | /* in quoted field */ |
| 689 | if (c == '\0') |
| 690 | ; |
| 691 | else if (c == dialect->escapechar) { |
| 692 | /* Possible escape character */ |
| 693 | self->state = ESCAPE_IN_QUOTED_FIELD; |
| 694 | } |
| 695 | else if (c == dialect->quotechar && |
| 696 | dialect->quoting != QUOTE_NONE) { |
| 697 | if (dialect->doublequote) { |
| 698 | /* doublequote; " represented by "" */ |
| 699 | self->state = QUOTE_IN_QUOTED_FIELD; |
| 700 | } |
| 701 | else { |
| 702 | /* end of quote part of field */ |
| 703 | self->state = IN_FIELD; |
| 704 | } |
| 705 | } |
| 706 | else { |
| 707 | /* normal character - save in field */ |
| 708 | if (parse_add_char(self, c) < 0) |
| 709 | return -1; |
| 710 | } |
| 711 | break; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 712 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 713 | case ESCAPE_IN_QUOTED_FIELD: |
| 714 | if (c == '\0') |
| 715 | c = '\n'; |
| 716 | if (parse_add_char(self, c) < 0) |
| 717 | return -1; |
| 718 | self->state = IN_QUOTED_FIELD; |
| 719 | break; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 720 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 721 | case QUOTE_IN_QUOTED_FIELD: |
Serhiy Storchaka | 6a7b3a7 | 2016-04-17 08:32:47 +0300 | [diff] [blame] | 722 | /* doublequote - seen a quote in a quoted field */ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 723 | if (dialect->quoting != QUOTE_NONE && |
| 724 | c == dialect->quotechar) { |
| 725 | /* save "" as " */ |
| 726 | if (parse_add_char(self, c) < 0) |
| 727 | return -1; |
| 728 | self->state = IN_QUOTED_FIELD; |
| 729 | } |
| 730 | else if (c == dialect->delimiter) { |
| 731 | /* save field - wait for new field */ |
| 732 | if (parse_save_field(self) < 0) |
| 733 | return -1; |
| 734 | self->state = START_FIELD; |
| 735 | } |
| 736 | else if (c == '\n' || c == '\r' || c == '\0') { |
| 737 | /* end of line - return [fields] */ |
| 738 | if (parse_save_field(self) < 0) |
| 739 | return -1; |
| 740 | self->state = (c == '\0' ? START_RECORD : EAT_CRNL); |
| 741 | } |
| 742 | else if (!dialect->strict) { |
| 743 | if (parse_add_char(self, c) < 0) |
| 744 | return -1; |
| 745 | self->state = IN_FIELD; |
| 746 | } |
| 747 | else { |
| 748 | /* illegal */ |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 749 | PyErr_Format(_csvstate_global->error_obj, "'%c' expected after '%c'", |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 750 | dialect->delimiter, |
| 751 | dialect->quotechar); |
| 752 | return -1; |
| 753 | } |
| 754 | break; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 755 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 756 | case EAT_CRNL: |
| 757 | if (c == '\n' || c == '\r') |
| 758 | ; |
| 759 | else if (c == '\0') |
| 760 | self->state = START_RECORD; |
| 761 | else { |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 762 | PyErr_Format(_csvstate_global->error_obj, "new-line character seen in unquoted field - do you need to open the file in universal-newline mode?"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 763 | return -1; |
| 764 | } |
| 765 | break; |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 766 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 767 | } |
| 768 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 769 | } |
| 770 | |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 771 | static int |
| 772 | parse_reset(ReaderObj *self) |
| 773 | { |
Serhiy Storchaka | 4884271 | 2016-04-06 09:45:48 +0300 | [diff] [blame] | 774 | Py_XSETREF(self->fields, PyList_New(0)); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 775 | if (self->fields == NULL) |
| 776 | return -1; |
| 777 | self->field_len = 0; |
| 778 | self->state = START_RECORD; |
| 779 | self->numeric_field = 0; |
| 780 | return 0; |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 781 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 782 | |
| 783 | static PyObject * |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 784 | Reader_iternext(ReaderObj *self) |
| 785 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 786 | PyObject *fields = NULL; |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 787 | Py_UCS4 c; |
| 788 | Py_ssize_t pos, linelen; |
| 789 | unsigned int kind; |
Serhiy Storchaka | cd8295f | 2020-04-11 10:48:40 +0300 | [diff] [blame] | 790 | const void *data; |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 791 | PyObject *lineobj; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 792 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 793 | if (parse_reset(self) < 0) |
| 794 | return NULL; |
| 795 | do { |
| 796 | lineobj = PyIter_Next(self->input_iter); |
| 797 | if (lineobj == NULL) { |
| 798 | /* End of input OR exception */ |
Senthil Kumaran | 67b7b98 | 2012-09-25 02:30:27 -0700 | [diff] [blame] | 799 | if (!PyErr_Occurred() && (self->field_len != 0 || |
| 800 | self->state == IN_QUOTED_FIELD)) { |
| 801 | if (self->dialect->strict) |
Senthil Kumaran | 49d1302 | 2012-09-25 02:37:20 -0700 | [diff] [blame] | 802 | PyErr_SetString(_csvstate_global->error_obj, |
| 803 | "unexpected end of data"); |
Senthil Kumaran | 67b7b98 | 2012-09-25 02:30:27 -0700 | [diff] [blame] | 804 | else if (parse_save_field(self) >= 0) |
| 805 | break; |
| 806 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 807 | return NULL; |
| 808 | } |
| 809 | if (!PyUnicode_Check(lineobj)) { |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 810 | PyErr_Format(_csvstate_global->error_obj, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 811 | "iterator should return strings, " |
| 812 | "not %.200s " |
| 813 | "(did you open the file in text mode?)", |
Victor Stinner | daa9756 | 2020-02-07 03:37:06 +0100 | [diff] [blame] | 814 | Py_TYPE(lineobj)->tp_name |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 815 | ); |
| 816 | Py_DECREF(lineobj); |
| 817 | return NULL; |
| 818 | } |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 819 | if (PyUnicode_READY(lineobj) == -1) { |
| 820 | Py_DECREF(lineobj); |
| 821 | return NULL; |
| 822 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 823 | ++self->line_num; |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 824 | kind = PyUnicode_KIND(lineobj); |
| 825 | data = PyUnicode_DATA(lineobj); |
| 826 | pos = 0; |
| 827 | linelen = PyUnicode_GET_LENGTH(lineobj); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 828 | while (linelen--) { |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 829 | c = PyUnicode_READ(kind, data, pos); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 830 | if (c == '\0') { |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 831 | Py_DECREF(lineobj); |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 832 | PyErr_Format(_csvstate_global->error_obj, |
Benjamin Peterson | 7821b4c | 2019-06-18 21:37:58 -0700 | [diff] [blame] | 833 | "line contains NUL"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 834 | goto err; |
| 835 | } |
| 836 | if (parse_process_char(self, c) < 0) { |
| 837 | Py_DECREF(lineobj); |
| 838 | goto err; |
| 839 | } |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 840 | pos++; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 841 | } |
| 842 | Py_DECREF(lineobj); |
| 843 | if (parse_process_char(self, 0) < 0) |
| 844 | goto err; |
| 845 | } while (self->state != START_RECORD); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 846 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 847 | fields = self->fields; |
| 848 | self->fields = NULL; |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 849 | err: |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 850 | return fields; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 851 | } |
| 852 | |
| 853 | static void |
| 854 | Reader_dealloc(ReaderObj *self) |
| 855 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 856 | PyObject_GC_UnTrack(self); |
| 857 | Py_XDECREF(self->dialect); |
| 858 | Py_XDECREF(self->input_iter); |
| 859 | Py_XDECREF(self->fields); |
| 860 | if (self->field != NULL) |
| 861 | PyMem_Free(self->field); |
| 862 | PyObject_GC_Del(self); |
Jeremy Hylton | 42a8aed | 2003-04-14 02:20:55 +0000 | [diff] [blame] | 863 | } |
| 864 | |
| 865 | static int |
| 866 | Reader_traverse(ReaderObj *self, visitproc visit, void *arg) |
| 867 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 868 | Py_VISIT(self->dialect); |
| 869 | Py_VISIT(self->input_iter); |
| 870 | Py_VISIT(self->fields); |
| 871 | return 0; |
Jeremy Hylton | 42a8aed | 2003-04-14 02:20:55 +0000 | [diff] [blame] | 872 | } |
| 873 | |
| 874 | static int |
| 875 | Reader_clear(ReaderObj *self) |
| 876 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 877 | Py_CLEAR(self->dialect); |
| 878 | Py_CLEAR(self->input_iter); |
| 879 | Py_CLEAR(self->fields); |
| 880 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 881 | } |
| 882 | |
| 883 | PyDoc_STRVAR(Reader_Type_doc, |
| 884 | "CSV reader\n" |
| 885 | "\n" |
| 886 | "Reader objects are responsible for reading and parsing tabular data\n" |
| 887 | "in CSV format.\n" |
| 888 | ); |
| 889 | |
| 890 | static struct PyMethodDef Reader_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 891 | { NULL, NULL } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 892 | }; |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 893 | #define R_OFF(x) offsetof(ReaderObj, x) |
| 894 | |
| 895 | static struct PyMemberDef Reader_memberlist[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 896 | { "dialect", T_OBJECT, R_OFF(dialect), READONLY }, |
| 897 | { "line_num", T_ULONG, R_OFF(line_num), READONLY }, |
| 898 | { NULL } |
Andrew McNamara | f69d94f | 2005-01-13 11:30:54 +0000 | [diff] [blame] | 899 | }; |
| 900 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 901 | |
| 902 | static PyTypeObject Reader_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 903 | PyVarObject_HEAD_INIT(NULL, 0) |
| 904 | "_csv.reader", /*tp_name*/ |
| 905 | sizeof(ReaderObj), /*tp_basicsize*/ |
| 906 | 0, /*tp_itemsize*/ |
| 907 | /* methods */ |
| 908 | (destructor)Reader_dealloc, /*tp_dealloc*/ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 909 | 0, /*tp_vectorcall_offset*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 910 | (getattrfunc)0, /*tp_getattr*/ |
| 911 | (setattrfunc)0, /*tp_setattr*/ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 912 | 0, /*tp_as_async*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 913 | (reprfunc)0, /*tp_repr*/ |
| 914 | 0, /*tp_as_number*/ |
| 915 | 0, /*tp_as_sequence*/ |
| 916 | 0, /*tp_as_mapping*/ |
| 917 | (hashfunc)0, /*tp_hash*/ |
| 918 | (ternaryfunc)0, /*tp_call*/ |
| 919 | (reprfunc)0, /*tp_str*/ |
| 920 | 0, /*tp_getattro*/ |
| 921 | 0, /*tp_setattro*/ |
| 922 | 0, /*tp_as_buffer*/ |
| 923 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | |
| 924 | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ |
| 925 | Reader_Type_doc, /*tp_doc*/ |
| 926 | (traverseproc)Reader_traverse, /*tp_traverse*/ |
| 927 | (inquiry)Reader_clear, /*tp_clear*/ |
| 928 | 0, /*tp_richcompare*/ |
| 929 | 0, /*tp_weaklistoffset*/ |
| 930 | PyObject_SelfIter, /*tp_iter*/ |
| 931 | (getiterfunc)Reader_iternext, /*tp_iternext*/ |
| 932 | Reader_methods, /*tp_methods*/ |
| 933 | Reader_memberlist, /*tp_members*/ |
| 934 | 0, /*tp_getset*/ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 935 | |
| 936 | }; |
| 937 | |
| 938 | static PyObject * |
| 939 | csv_reader(PyObject *module, PyObject *args, PyObject *keyword_args) |
| 940 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 941 | PyObject * iterator, * dialect = NULL; |
| 942 | ReaderObj * self = PyObject_GC_New(ReaderObj, &Reader_Type); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 943 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 944 | if (!self) |
| 945 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 946 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 947 | self->dialect = NULL; |
| 948 | self->fields = NULL; |
| 949 | self->input_iter = NULL; |
| 950 | self->field = NULL; |
| 951 | self->field_size = 0; |
| 952 | self->line_num = 0; |
Andrew McNamara | 0f0599d | 2005-01-12 09:45:18 +0000 | [diff] [blame] | 953 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 954 | if (parse_reset(self) < 0) { |
| 955 | Py_DECREF(self); |
| 956 | return NULL; |
| 957 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 958 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 959 | if (!PyArg_UnpackTuple(args, "", 1, 2, &iterator, &dialect)) { |
| 960 | Py_DECREF(self); |
| 961 | return NULL; |
| 962 | } |
| 963 | self->input_iter = PyObject_GetIter(iterator); |
| 964 | if (self->input_iter == NULL) { |
| 965 | PyErr_SetString(PyExc_TypeError, |
| 966 | "argument 1 must be an iterator"); |
| 967 | Py_DECREF(self); |
| 968 | return NULL; |
| 969 | } |
| 970 | self->dialect = (DialectObj *)_call_dialect(dialect, keyword_args); |
| 971 | if (self->dialect == NULL) { |
| 972 | Py_DECREF(self); |
| 973 | return NULL; |
| 974 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 975 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 976 | PyObject_GC_Track(self); |
| 977 | return (PyObject *)self; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 978 | } |
| 979 | |
| 980 | /* |
| 981 | * WRITER |
| 982 | */ |
| 983 | /* ---------------------------------------------------------------- */ |
| 984 | static void |
| 985 | join_reset(WriterObj *self) |
| 986 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 987 | self->rec_len = 0; |
| 988 | self->num_fields = 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 989 | } |
| 990 | |
| 991 | #define MEM_INCR 32768 |
| 992 | |
| 993 | /* Calculate new record length or append field to record. Return new |
| 994 | * record length. |
| 995 | */ |
Antoine Pitrou | 4045575 | 2010-08-15 18:51:10 +0000 | [diff] [blame] | 996 | static Py_ssize_t |
Serhiy Storchaka | cd8295f | 2020-04-11 10:48:40 +0300 | [diff] [blame] | 997 | join_append_data(WriterObj *self, unsigned int field_kind, const void *field_data, |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 998 | Py_ssize_t field_len, int *quoted, |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 999 | int copy_phase) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1000 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1001 | DialectObj *dialect = self->dialect; |
| 1002 | int i; |
Antoine Pitrou | 4045575 | 2010-08-15 18:51:10 +0000 | [diff] [blame] | 1003 | Py_ssize_t rec_len; |
Andrew McNamara | c89f284 | 2005-01-12 07:44:42 +0000 | [diff] [blame] | 1004 | |
Benjamin Peterson | 6e01d90 | 2016-08-13 17:17:06 -0700 | [diff] [blame] | 1005 | #define INCLEN \ |
| 1006 | do {\ |
| 1007 | if (!copy_phase && rec_len == PY_SSIZE_T_MAX) { \ |
| 1008 | goto overflow; \ |
| 1009 | } \ |
| 1010 | rec_len++; \ |
| 1011 | } while(0) |
| 1012 | |
| 1013 | #define ADDCH(c) \ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1014 | do {\ |
| 1015 | if (copy_phase) \ |
| 1016 | self->rec[rec_len] = c;\ |
Benjamin Peterson | 6e01d90 | 2016-08-13 17:17:06 -0700 | [diff] [blame] | 1017 | INCLEN;\ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1018 | } while(0) |
Andrew McNamara | c89f284 | 2005-01-12 07:44:42 +0000 | [diff] [blame] | 1019 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1020 | rec_len = self->rec_len; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1021 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1022 | /* If this is not the first field we need a field separator */ |
| 1023 | if (self->num_fields > 0) |
| 1024 | ADDCH(dialect->delimiter); |
Andrew McNamara | c89f284 | 2005-01-12 07:44:42 +0000 | [diff] [blame] | 1025 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1026 | /* Handle preceding quote */ |
| 1027 | if (copy_phase && *quoted) |
| 1028 | ADDCH(dialect->quotechar); |
Andrew McNamara | c89f284 | 2005-01-12 07:44:42 +0000 | [diff] [blame] | 1029 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1030 | /* Copy/count field data */ |
| 1031 | /* If field is null just pass over */ |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1032 | for (i = 0; field_data && (i < field_len); i++) { |
| 1033 | Py_UCS4 c = PyUnicode_READ(field_kind, field_data, i); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1034 | int want_escape = 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1035 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1036 | if (c == dialect->delimiter || |
| 1037 | c == dialect->escapechar || |
| 1038 | c == dialect->quotechar || |
Martin v. Löwis | 5f4f4c5 | 2011-11-01 18:42:23 +0100 | [diff] [blame] | 1039 | PyUnicode_FindChar( |
| 1040 | dialect->lineterminator, c, 0, |
| 1041 | PyUnicode_GET_LENGTH(dialect->lineterminator), 1) >= 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1042 | if (dialect->quoting == QUOTE_NONE) |
| 1043 | want_escape = 1; |
| 1044 | else { |
| 1045 | if (c == dialect->quotechar) { |
| 1046 | if (dialect->doublequote) |
| 1047 | ADDCH(dialect->quotechar); |
| 1048 | else |
| 1049 | want_escape = 1; |
| 1050 | } |
| 1051 | if (!want_escape) |
| 1052 | *quoted = 1; |
| 1053 | } |
| 1054 | if (want_escape) { |
| 1055 | if (!dialect->escapechar) { |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1056 | PyErr_Format(_csvstate_global->error_obj, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1057 | "need to escape, but no escapechar set"); |
| 1058 | return -1; |
| 1059 | } |
| 1060 | ADDCH(dialect->escapechar); |
| 1061 | } |
| 1062 | } |
| 1063 | /* Copy field character into record buffer. |
| 1064 | */ |
| 1065 | ADDCH(c); |
| 1066 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1067 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1068 | if (*quoted) { |
| 1069 | if (copy_phase) |
| 1070 | ADDCH(dialect->quotechar); |
Benjamin Peterson | 6e01d90 | 2016-08-13 17:17:06 -0700 | [diff] [blame] | 1071 | else { |
| 1072 | INCLEN; /* starting quote */ |
| 1073 | INCLEN; /* ending quote */ |
| 1074 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1075 | } |
| 1076 | return rec_len; |
Benjamin Peterson | 6e01d90 | 2016-08-13 17:17:06 -0700 | [diff] [blame] | 1077 | |
| 1078 | overflow: |
| 1079 | PyErr_NoMemory(); |
| 1080 | return -1; |
Andrew McNamara | c89f284 | 2005-01-12 07:44:42 +0000 | [diff] [blame] | 1081 | #undef ADDCH |
Benjamin Peterson | 6e01d90 | 2016-08-13 17:17:06 -0700 | [diff] [blame] | 1082 | #undef INCLEN |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1083 | } |
| 1084 | |
| 1085 | static int |
Antoine Pitrou | 4045575 | 2010-08-15 18:51:10 +0000 | [diff] [blame] | 1086 | join_check_rec_size(WriterObj *self, Py_ssize_t rec_len) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1087 | { |
Sergey Fedoseev | 67b9cc8 | 2018-08-16 09:27:50 +0500 | [diff] [blame] | 1088 | assert(rec_len >= 0); |
Amaury Forgeot d'Arc | 9c74b14 | 2008-06-18 00:47:36 +0000 | [diff] [blame] | 1089 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1090 | if (rec_len > self->rec_size) { |
Sergey Fedoseev | 67b9cc8 | 2018-08-16 09:27:50 +0500 | [diff] [blame] | 1091 | size_t rec_size_new = (size_t)(rec_len / MEM_INCR + 1) * MEM_INCR; |
| 1092 | Py_UCS4 *rec_new = self->rec; |
| 1093 | PyMem_Resize(rec_new, Py_UCS4, rec_size_new); |
| 1094 | if (rec_new == NULL) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1095 | PyErr_NoMemory(); |
| 1096 | return 0; |
| 1097 | } |
Sergey Fedoseev | 67b9cc8 | 2018-08-16 09:27:50 +0500 | [diff] [blame] | 1098 | self->rec = rec_new; |
| 1099 | self->rec_size = (Py_ssize_t)rec_size_new; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1100 | } |
| 1101 | return 1; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1102 | } |
| 1103 | |
| 1104 | static int |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1105 | join_append(WriterObj *self, PyObject *field, int quoted) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1106 | { |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1107 | unsigned int field_kind = -1; |
Serhiy Storchaka | cd8295f | 2020-04-11 10:48:40 +0300 | [diff] [blame] | 1108 | const void *field_data = NULL; |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1109 | Py_ssize_t field_len = 0; |
Antoine Pitrou | 4045575 | 2010-08-15 18:51:10 +0000 | [diff] [blame] | 1110 | Py_ssize_t rec_len; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1111 | |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1112 | if (field != NULL) { |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 1113 | if (PyUnicode_READY(field) == -1) |
| 1114 | return 0; |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1115 | field_kind = PyUnicode_KIND(field); |
| 1116 | field_data = PyUnicode_DATA(field); |
| 1117 | field_len = PyUnicode_GET_LENGTH(field); |
| 1118 | } |
| 1119 | rec_len = join_append_data(self, field_kind, field_data, field_len, |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1120 | "ed, 0); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1121 | if (rec_len < 0) |
| 1122 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1123 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1124 | /* grow record buffer if necessary */ |
| 1125 | if (!join_check_rec_size(self, rec_len)) |
| 1126 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1127 | |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1128 | self->rec_len = join_append_data(self, field_kind, field_data, field_len, |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1129 | "ed, 1); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1130 | self->num_fields++; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1131 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1132 | return 1; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1133 | } |
| 1134 | |
| 1135 | static int |
| 1136 | join_append_lineterminator(WriterObj *self) |
| 1137 | { |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1138 | Py_ssize_t terminator_len, i; |
| 1139 | unsigned int term_kind; |
Serhiy Storchaka | cd8295f | 2020-04-11 10:48:40 +0300 | [diff] [blame] | 1140 | const void *term_data; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1141 | |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1142 | terminator_len = PyUnicode_GET_LENGTH(self->dialect->lineterminator); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1143 | if (terminator_len == -1) |
| 1144 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1145 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1146 | /* grow record buffer if necessary */ |
| 1147 | if (!join_check_rec_size(self, self->rec_len + terminator_len)) |
| 1148 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1149 | |
Antoine Pitrou | 77ea640 | 2011-10-07 04:26:55 +0200 | [diff] [blame] | 1150 | term_kind = PyUnicode_KIND(self->dialect->lineterminator); |
| 1151 | term_data = PyUnicode_DATA(self->dialect->lineterminator); |
| 1152 | for (i = 0; i < terminator_len; i++) |
| 1153 | self->rec[self->rec_len + i] = PyUnicode_READ(term_kind, term_data, i); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1154 | self->rec_len += terminator_len; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1155 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1156 | return 1; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1157 | } |
| 1158 | |
| 1159 | PyDoc_STRVAR(csv_writerow_doc, |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1160 | "writerow(iterable)\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1161 | "\n" |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1162 | "Construct and write a CSV record from an iterable of fields. Non-string\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1163 | "elements will be converted to string."); |
| 1164 | |
| 1165 | static PyObject * |
| 1166 | csv_writerow(WriterObj *self, PyObject *seq) |
| 1167 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1168 | DialectObj *dialect = self->dialect; |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1169 | PyObject *iter, *field, *line, *result; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1170 | |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1171 | iter = PyObject_GetIter(seq); |
| 1172 | if (iter == NULL) |
| 1173 | return PyErr_Format(_csvstate_global->error_obj, |
| 1174 | "iterable expected, not %.200s", |
Victor Stinner | daa9756 | 2020-02-07 03:37:06 +0100 | [diff] [blame] | 1175 | Py_TYPE(seq)->tp_name); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1176 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1177 | /* Join all fields in internal buffer. |
| 1178 | */ |
| 1179 | join_reset(self); |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1180 | while ((field = PyIter_Next(iter))) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1181 | int append_ok; |
| 1182 | int quoted; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1183 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1184 | switch (dialect->quoting) { |
| 1185 | case QUOTE_NONNUMERIC: |
| 1186 | quoted = !PyNumber_Check(field); |
| 1187 | break; |
| 1188 | case QUOTE_ALL: |
| 1189 | quoted = 1; |
| 1190 | break; |
| 1191 | default: |
| 1192 | quoted = 0; |
| 1193 | break; |
| 1194 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1195 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1196 | if (PyUnicode_Check(field)) { |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1197 | append_ok = join_append(self, field, quoted); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1198 | Py_DECREF(field); |
| 1199 | } |
| 1200 | else if (field == Py_None) { |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1201 | append_ok = join_append(self, NULL, quoted); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1202 | Py_DECREF(field); |
| 1203 | } |
| 1204 | else { |
| 1205 | PyObject *str; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1206 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1207 | str = PyObject_Str(field); |
| 1208 | Py_DECREF(field); |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1209 | if (str == NULL) { |
| 1210 | Py_DECREF(iter); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1211 | return NULL; |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1212 | } |
| 1213 | append_ok = join_append(self, str, quoted); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1214 | Py_DECREF(str); |
| 1215 | } |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1216 | if (!append_ok) { |
| 1217 | Py_DECREF(iter); |
| 1218 | return NULL; |
| 1219 | } |
| 1220 | } |
| 1221 | Py_DECREF(iter); |
| 1222 | if (PyErr_Occurred()) |
| 1223 | return NULL; |
| 1224 | |
Licht Takeuchi | 2001900 | 2017-12-12 18:57:06 +0900 | [diff] [blame] | 1225 | if (self->num_fields > 0 && self->rec_len == 0) { |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1226 | if (dialect->quoting == QUOTE_NONE) { |
| 1227 | PyErr_Format(_csvstate_global->error_obj, |
| 1228 | "single empty field record must be quoted"); |
| 1229 | return NULL; |
| 1230 | } |
| 1231 | self->num_fields--; |
| 1232 | if (!join_append(self, NULL, 1)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1233 | return NULL; |
| 1234 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1235 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1236 | /* Add line terminator. |
| 1237 | */ |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1238 | if (!join_append_lineterminator(self)) { |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1239 | return NULL; |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1240 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1241 | |
Antoine Pitrou | 72ca65d | 2011-10-07 04:35:30 +0200 | [diff] [blame] | 1242 | line = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, |
| 1243 | (void *) self->rec, self->rec_len); |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1244 | if (line == NULL) { |
Antoine Pitrou | 72ca65d | 2011-10-07 04:35:30 +0200 | [diff] [blame] | 1245 | return NULL; |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1246 | } |
Petr Viktorin | ffd9753 | 2020-02-11 17:46:57 +0100 | [diff] [blame] | 1247 | result = PyObject_CallOneArg(self->write, line); |
Antoine Pitrou | 72ca65d | 2011-10-07 04:35:30 +0200 | [diff] [blame] | 1248 | Py_DECREF(line); |
| 1249 | return result; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1250 | } |
| 1251 | |
Skip Montanaro | 860fc0b | 2003-04-12 18:57:52 +0000 | [diff] [blame] | 1252 | PyDoc_STRVAR(csv_writerows_doc, |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1253 | "writerows(iterable of iterables)\n" |
Skip Montanaro | 860fc0b | 2003-04-12 18:57:52 +0000 | [diff] [blame] | 1254 | "\n" |
Serhiy Storchaka | 7901b48 | 2015-03-30 09:09:54 +0300 | [diff] [blame] | 1255 | "Construct and write a series of iterables to a csv file. Non-string\n" |
Skip Montanaro | 860fc0b | 2003-04-12 18:57:52 +0000 | [diff] [blame] | 1256 | "elements will be converted to string."); |
| 1257 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1258 | static PyObject * |
| 1259 | csv_writerows(WriterObj *self, PyObject *seqseq) |
| 1260 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1261 | PyObject *row_iter, *row_obj, *result; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1262 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1263 | row_iter = PyObject_GetIter(seqseq); |
| 1264 | if (row_iter == NULL) { |
| 1265 | PyErr_SetString(PyExc_TypeError, |
| 1266 | "writerows() argument must be iterable"); |
| 1267 | return NULL; |
| 1268 | } |
| 1269 | while ((row_obj = PyIter_Next(row_iter))) { |
| 1270 | result = csv_writerow(self, row_obj); |
| 1271 | Py_DECREF(row_obj); |
| 1272 | if (!result) { |
| 1273 | Py_DECREF(row_iter); |
| 1274 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1275 | } |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1276 | else |
| 1277 | Py_DECREF(result); |
| 1278 | } |
| 1279 | Py_DECREF(row_iter); |
| 1280 | if (PyErr_Occurred()) |
| 1281 | return NULL; |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1282 | Py_RETURN_NONE; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1283 | } |
| 1284 | |
| 1285 | static struct PyMethodDef Writer_methods[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1286 | { "writerow", (PyCFunction)csv_writerow, METH_O, csv_writerow_doc}, |
| 1287 | { "writerows", (PyCFunction)csv_writerows, METH_O, csv_writerows_doc}, |
| 1288 | { NULL, NULL } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1289 | }; |
| 1290 | |
| 1291 | #define W_OFF(x) offsetof(WriterObj, x) |
| 1292 | |
| 1293 | static struct PyMemberDef Writer_memberlist[] = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1294 | { "dialect", T_OBJECT, W_OFF(dialect), READONLY }, |
| 1295 | { NULL } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1296 | }; |
| 1297 | |
| 1298 | static void |
| 1299 | Writer_dealloc(WriterObj *self) |
| 1300 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1301 | PyObject_GC_UnTrack(self); |
| 1302 | Py_XDECREF(self->dialect); |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1303 | Py_XDECREF(self->write); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1304 | if (self->rec != NULL) |
| 1305 | PyMem_Free(self->rec); |
| 1306 | PyObject_GC_Del(self); |
Jeremy Hylton | 42a8aed | 2003-04-14 02:20:55 +0000 | [diff] [blame] | 1307 | } |
| 1308 | |
| 1309 | static int |
| 1310 | Writer_traverse(WriterObj *self, visitproc visit, void *arg) |
| 1311 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1312 | Py_VISIT(self->dialect); |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1313 | Py_VISIT(self->write); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1314 | return 0; |
Jeremy Hylton | 42a8aed | 2003-04-14 02:20:55 +0000 | [diff] [blame] | 1315 | } |
| 1316 | |
| 1317 | static int |
| 1318 | Writer_clear(WriterObj *self) |
| 1319 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1320 | Py_CLEAR(self->dialect); |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1321 | Py_CLEAR(self->write); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1322 | return 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1323 | } |
| 1324 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1325 | PyDoc_STRVAR(Writer_Type_doc, |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1326 | "CSV writer\n" |
| 1327 | "\n" |
| 1328 | "Writer objects are responsible for generating tabular data\n" |
| 1329 | "in CSV format from sequence input.\n" |
| 1330 | ); |
| 1331 | |
| 1332 | static PyTypeObject Writer_Type = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1333 | PyVarObject_HEAD_INIT(NULL, 0) |
| 1334 | "_csv.writer", /*tp_name*/ |
| 1335 | sizeof(WriterObj), /*tp_basicsize*/ |
| 1336 | 0, /*tp_itemsize*/ |
| 1337 | /* methods */ |
| 1338 | (destructor)Writer_dealloc, /*tp_dealloc*/ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1339 | 0, /*tp_vectorcall_offset*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1340 | (getattrfunc)0, /*tp_getattr*/ |
| 1341 | (setattrfunc)0, /*tp_setattr*/ |
Jeroen Demeyer | 530f506 | 2019-05-31 04:13:39 +0200 | [diff] [blame] | 1342 | 0, /*tp_as_async*/ |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1343 | (reprfunc)0, /*tp_repr*/ |
| 1344 | 0, /*tp_as_number*/ |
| 1345 | 0, /*tp_as_sequence*/ |
| 1346 | 0, /*tp_as_mapping*/ |
| 1347 | (hashfunc)0, /*tp_hash*/ |
| 1348 | (ternaryfunc)0, /*tp_call*/ |
| 1349 | (reprfunc)0, /*tp_str*/ |
| 1350 | 0, /*tp_getattro*/ |
| 1351 | 0, /*tp_setattro*/ |
| 1352 | 0, /*tp_as_buffer*/ |
| 1353 | Py_TPFLAGS_DEFAULT | Py_TPFLAGS_BASETYPE | |
| 1354 | Py_TPFLAGS_HAVE_GC, /*tp_flags*/ |
| 1355 | Writer_Type_doc, |
| 1356 | (traverseproc)Writer_traverse, /*tp_traverse*/ |
| 1357 | (inquiry)Writer_clear, /*tp_clear*/ |
| 1358 | 0, /*tp_richcompare*/ |
| 1359 | 0, /*tp_weaklistoffset*/ |
| 1360 | (getiterfunc)0, /*tp_iter*/ |
| 1361 | (getiterfunc)0, /*tp_iternext*/ |
| 1362 | Writer_methods, /*tp_methods*/ |
| 1363 | Writer_memberlist, /*tp_members*/ |
| 1364 | 0, /*tp_getset*/ |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1365 | }; |
| 1366 | |
| 1367 | static PyObject * |
| 1368 | csv_writer(PyObject *module, PyObject *args, PyObject *keyword_args) |
| 1369 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1370 | PyObject * output_file, * dialect = NULL; |
| 1371 | WriterObj * self = PyObject_GC_New(WriterObj, &Writer_Type); |
Martin v. Löwis | bd928fe | 2011-10-14 10:20:37 +0200 | [diff] [blame] | 1372 | _Py_IDENTIFIER(write); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1373 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1374 | if (!self) |
| 1375 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1376 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1377 | self->dialect = NULL; |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1378 | self->write = NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1379 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1380 | self->rec = NULL; |
| 1381 | self->rec_size = 0; |
| 1382 | self->rec_len = 0; |
| 1383 | self->num_fields = 0; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1384 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1385 | if (!PyArg_UnpackTuple(args, "", 1, 2, &output_file, &dialect)) { |
| 1386 | Py_DECREF(self); |
| 1387 | return NULL; |
| 1388 | } |
Serhiy Storchaka | 41c57b3 | 2019-09-01 12:03:39 +0300 | [diff] [blame] | 1389 | if (_PyObject_LookupAttrId(output_file, &PyId_write, &self->write) < 0) { |
| 1390 | Py_DECREF(self); |
| 1391 | return NULL; |
| 1392 | } |
Rémi Lapeyre | 2bc158f | 2019-05-14 15:45:14 +0200 | [diff] [blame] | 1393 | if (self->write == NULL || !PyCallable_Check(self->write)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1394 | PyErr_SetString(PyExc_TypeError, |
| 1395 | "argument 1 must have a \"write\" method"); |
| 1396 | Py_DECREF(self); |
| 1397 | return NULL; |
| 1398 | } |
| 1399 | self->dialect = (DialectObj *)_call_dialect(dialect, keyword_args); |
| 1400 | if (self->dialect == NULL) { |
| 1401 | Py_DECREF(self); |
| 1402 | return NULL; |
| 1403 | } |
| 1404 | PyObject_GC_Track(self); |
| 1405 | return (PyObject *)self; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1406 | } |
| 1407 | |
| 1408 | /* |
| 1409 | * DIALECT REGISTRY |
| 1410 | */ |
| 1411 | static PyObject * |
| 1412 | csv_list_dialects(PyObject *module, PyObject *args) |
| 1413 | { |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1414 | return PyDict_Keys(_csvstate_global->dialects); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1415 | } |
| 1416 | |
| 1417 | static PyObject * |
Andrew McNamara | 8662597 | 2005-01-11 01:28:33 +0000 | [diff] [blame] | 1418 | csv_register_dialect(PyObject *module, PyObject *args, PyObject *kwargs) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1419 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1420 | PyObject *name_obj, *dialect_obj = NULL; |
| 1421 | PyObject *dialect; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1422 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1423 | if (!PyArg_UnpackTuple(args, "", 1, 2, &name_obj, &dialect_obj)) |
| 1424 | return NULL; |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 1425 | if (!PyUnicode_Check(name_obj)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1426 | PyErr_SetString(PyExc_TypeError, |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 1427 | "dialect name must be a string"); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1428 | return NULL; |
| 1429 | } |
Stefan Krah | e6996ed | 2012-11-02 14:44:20 +0100 | [diff] [blame] | 1430 | if (PyUnicode_READY(name_obj) == -1) |
| 1431 | return NULL; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1432 | dialect = _call_dialect(dialect_obj, kwargs); |
| 1433 | if (dialect == NULL) |
| 1434 | return NULL; |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1435 | if (PyDict_SetItem(_csvstate_global->dialects, name_obj, dialect) < 0) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1436 | Py_DECREF(dialect); |
| 1437 | return NULL; |
| 1438 | } |
| 1439 | Py_DECREF(dialect); |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1440 | Py_RETURN_NONE; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1441 | } |
| 1442 | |
| 1443 | static PyObject * |
Skip Montanaro | 577c7a7 | 2003-04-12 19:17:14 +0000 | [diff] [blame] | 1444 | csv_unregister_dialect(PyObject *module, PyObject *name_obj) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1445 | { |
Serhiy Storchaka | a24107b | 2019-02-25 17:59:46 +0200 | [diff] [blame] | 1446 | if (PyDict_DelItem(_csvstate_global->dialects, name_obj) < 0) { |
| 1447 | if (PyErr_ExceptionMatches(PyExc_KeyError)) { |
| 1448 | PyErr_Format(_csvstate_global->error_obj, "unknown dialect"); |
| 1449 | } |
| 1450 | return NULL; |
| 1451 | } |
Serhiy Storchaka | 228b12e | 2017-01-23 09:47:21 +0200 | [diff] [blame] | 1452 | Py_RETURN_NONE; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1453 | } |
| 1454 | |
| 1455 | static PyObject * |
Skip Montanaro | 577c7a7 | 2003-04-12 19:17:14 +0000 | [diff] [blame] | 1456 | csv_get_dialect(PyObject *module, PyObject *name_obj) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1457 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1458 | return get_dialect_from_registry(name_obj); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1459 | } |
| 1460 | |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 1461 | static PyObject * |
Andrew McNamara | 31d8896 | 2005-01-12 03:45:10 +0000 | [diff] [blame] | 1462 | csv_field_size_limit(PyObject *module, PyObject *args) |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 1463 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1464 | PyObject *new_limit = NULL; |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1465 | long old_limit = _csvstate_global->field_limit; |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 1466 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1467 | if (!PyArg_UnpackTuple(args, "field_size_limit", 0, 1, &new_limit)) |
| 1468 | return NULL; |
| 1469 | if (new_limit != NULL) { |
| 1470 | if (!PyLong_CheckExact(new_limit)) { |
| 1471 | PyErr_Format(PyExc_TypeError, |
| 1472 | "limit must be an integer"); |
| 1473 | return NULL; |
| 1474 | } |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1475 | _csvstate_global->field_limit = PyLong_AsLong(new_limit); |
| 1476 | if (_csvstate_global->field_limit == -1 && PyErr_Occurred()) { |
| 1477 | _csvstate_global->field_limit = old_limit; |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1478 | return NULL; |
| 1479 | } |
| 1480 | } |
| 1481 | return PyLong_FromLong(old_limit); |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 1482 | } |
| 1483 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1484 | /* |
| 1485 | * MODULE |
| 1486 | */ |
| 1487 | |
| 1488 | PyDoc_STRVAR(csv_module_doc, |
| 1489 | "CSV parsing and writing.\n" |
| 1490 | "\n" |
| 1491 | "This module provides classes that assist in the reading and writing\n" |
| 1492 | "of Comma Separated Value (CSV) files, and implements the interface\n" |
| 1493 | "described by PEP 305. Although many CSV files are simple to parse,\n" |
| 1494 | "the format is not formally defined by a stable specification and\n" |
| 1495 | "is subtle enough that parsing lines of a CSV file with something\n" |
| 1496 | "like line.split(\",\") is bound to fail. The module supports three\n" |
| 1497 | "basic APIs: reading, writing, and registration of dialects.\n" |
| 1498 | "\n" |
| 1499 | "\n" |
| 1500 | "DIALECT REGISTRATION:\n" |
| 1501 | "\n" |
| 1502 | "Readers and writers support a dialect argument, which is a convenient\n" |
| 1503 | "handle on a group of settings. When the dialect argument is a string,\n" |
| 1504 | "it identifies one of the dialects previously registered with the module.\n" |
| 1505 | "If it is a class or instance, the attributes of the argument are used as\n" |
| 1506 | "the settings for the reader or writer:\n" |
| 1507 | "\n" |
| 1508 | " class excel:\n" |
| 1509 | " delimiter = ','\n" |
| 1510 | " quotechar = '\"'\n" |
| 1511 | " escapechar = None\n" |
| 1512 | " doublequote = True\n" |
| 1513 | " skipinitialspace = False\n" |
Johannes Gijsbers | 8d3b9dd | 2004-08-15 12:23:10 +0000 | [diff] [blame] | 1514 | " lineterminator = '\\r\\n'\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1515 | " quoting = QUOTE_MINIMAL\n" |
| 1516 | "\n" |
| 1517 | "SETTINGS:\n" |
| 1518 | "\n" |
oldk | aa0735f | 2018-02-02 16:52:55 +0800 | [diff] [blame] | 1519 | " * quotechar - specifies a one-character string to use as the\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1520 | " quoting character. It defaults to '\"'.\n" |
oldk | aa0735f | 2018-02-02 16:52:55 +0800 | [diff] [blame] | 1521 | " * delimiter - specifies a one-character string to use as the\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1522 | " field separator. It defaults to ','.\n" |
| 1523 | " * skipinitialspace - specifies how to interpret whitespace which\n" |
| 1524 | " immediately follows a delimiter. It defaults to False, which\n" |
| 1525 | " means that whitespace immediately following a delimiter is part\n" |
| 1526 | " of the following field.\n" |
oldk | aa0735f | 2018-02-02 16:52:55 +0800 | [diff] [blame] | 1527 | " * lineterminator - specifies the character sequence which should\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1528 | " terminate rows.\n" |
| 1529 | " * quoting - controls when quotes should be generated by the writer.\n" |
| 1530 | " It can take on any of the following module constants:\n" |
| 1531 | "\n" |
| 1532 | " csv.QUOTE_MINIMAL means only when required, for example, when a\n" |
| 1533 | " field contains either the quotechar or the delimiter\n" |
| 1534 | " csv.QUOTE_ALL means that quotes are always placed around fields.\n" |
| 1535 | " csv.QUOTE_NONNUMERIC means that quotes are always placed around\n" |
Skip Montanaro | 148eb6a | 2003-12-02 18:57:47 +0000 | [diff] [blame] | 1536 | " fields which do not parse as integers or floating point\n" |
| 1537 | " numbers.\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1538 | " csv.QUOTE_NONE means that quotes are never placed around fields.\n" |
oldk | aa0735f | 2018-02-02 16:52:55 +0800 | [diff] [blame] | 1539 | " * escapechar - specifies a one-character string used to escape\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1540 | " the delimiter when quoting is set to QUOTE_NONE.\n" |
| 1541 | " * doublequote - controls the handling of quotes inside fields. When\n" |
| 1542 | " True, two consecutive quotes are interpreted as one during read,\n" |
| 1543 | " and when writing, each quote character embedded in the data is\n" |
| 1544 | " written as two quotes\n"); |
| 1545 | |
| 1546 | PyDoc_STRVAR(csv_reader_doc, |
| 1547 | " csv_reader = reader(iterable [, dialect='excel']\n" |
| 1548 | " [optional keyword args])\n" |
| 1549 | " for row in csv_reader:\n" |
| 1550 | " process(row)\n" |
| 1551 | "\n" |
| 1552 | "The \"iterable\" argument can be any object that returns a line\n" |
| 1553 | "of input for each iteration, such as a file object or a list. The\n" |
| 1554 | "optional \"dialect\" parameter is discussed below. The function\n" |
| 1555 | "also accepts optional keyword arguments which override settings\n" |
| 1556 | "provided by the dialect.\n" |
| 1557 | "\n" |
| 1558 | "The returned object is an iterator. Each iteration returns a row\n" |
Berker Peksag | e2382c5 | 2015-10-02 19:25:32 +0300 | [diff] [blame] | 1559 | "of the CSV file (which can span multiple input lines).\n"); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1560 | |
| 1561 | PyDoc_STRVAR(csv_writer_doc, |
| 1562 | " csv_writer = csv.writer(fileobj [, dialect='excel']\n" |
| 1563 | " [optional keyword args])\n" |
Thomas Wouters | 49fd7fa | 2006-04-21 10:40:58 +0000 | [diff] [blame] | 1564 | " for row in sequence:\n" |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1565 | " csv_writer.writerow(row)\n" |
| 1566 | "\n" |
| 1567 | " [or]\n" |
| 1568 | "\n" |
| 1569 | " csv_writer = csv.writer(fileobj [, dialect='excel']\n" |
| 1570 | " [optional keyword args])\n" |
| 1571 | " csv_writer.writerows(rows)\n" |
| 1572 | "\n" |
| 1573 | "The \"fileobj\" argument can be any object that supports the file API.\n"); |
| 1574 | |
| 1575 | PyDoc_STRVAR(csv_list_dialects_doc, |
| 1576 | "Return a list of all know dialect names.\n" |
| 1577 | " names = csv.list_dialects()"); |
| 1578 | |
| 1579 | PyDoc_STRVAR(csv_get_dialect_doc, |
| 1580 | "Return the dialect instance associated with name.\n" |
| 1581 | " dialect = csv.get_dialect(name)"); |
| 1582 | |
| 1583 | PyDoc_STRVAR(csv_register_dialect_doc, |
| 1584 | "Create a mapping from a string name to a dialect class.\n" |
Berker Peksag | 12b50ce | 2015-06-05 15:17:51 +0300 | [diff] [blame] | 1585 | " dialect = csv.register_dialect(name[, dialect[, **fmtparams]])"); |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1586 | |
| 1587 | PyDoc_STRVAR(csv_unregister_dialect_doc, |
| 1588 | "Delete the name/dialect mapping associated with a string name.\n" |
| 1589 | " csv.unregister_dialect(name)"); |
| 1590 | |
Andrew McNamara | 31d8896 | 2005-01-12 03:45:10 +0000 | [diff] [blame] | 1591 | PyDoc_STRVAR(csv_field_size_limit_doc, |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 1592 | "Sets an upper limit on parsed fields.\n" |
Andrew McNamara | 31d8896 | 2005-01-12 03:45:10 +0000 | [diff] [blame] | 1593 | " csv.field_size_limit([limit])\n" |
Andrew McNamara | e4d05c4 | 2005-01-11 07:32:02 +0000 | [diff] [blame] | 1594 | "\n" |
| 1595 | "Returns old limit. If limit is not given, no new limit is set and\n" |
| 1596 | "the old limit is returned"); |
| 1597 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1598 | static struct PyMethodDef csv_methods[] = { |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 1599 | { "reader", (PyCFunction)(void(*)(void))csv_reader, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1600 | METH_VARARGS | METH_KEYWORDS, csv_reader_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 1601 | { "writer", (PyCFunction)(void(*)(void))csv_writer, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1602 | METH_VARARGS | METH_KEYWORDS, csv_writer_doc}, |
| 1603 | { "list_dialects", (PyCFunction)csv_list_dialects, |
| 1604 | METH_NOARGS, csv_list_dialects_doc}, |
Serhiy Storchaka | 62be742 | 2018-11-27 13:27:31 +0200 | [diff] [blame] | 1605 | { "register_dialect", (PyCFunction)(void(*)(void))csv_register_dialect, |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1606 | METH_VARARGS | METH_KEYWORDS, csv_register_dialect_doc}, |
| 1607 | { "unregister_dialect", (PyCFunction)csv_unregister_dialect, |
| 1608 | METH_O, csv_unregister_dialect_doc}, |
| 1609 | { "get_dialect", (PyCFunction)csv_get_dialect, |
| 1610 | METH_O, csv_get_dialect_doc}, |
| 1611 | { "field_size_limit", (PyCFunction)csv_field_size_limit, |
| 1612 | METH_VARARGS, csv_field_size_limit_doc}, |
| 1613 | { NULL, NULL } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1614 | }; |
| 1615 | |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1616 | static struct PyModuleDef _csvmodule = { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1617 | PyModuleDef_HEAD_INIT, |
| 1618 | "_csv", |
| 1619 | csv_module_doc, |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1620 | sizeof(_csvstate), |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1621 | csv_methods, |
| 1622 | NULL, |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1623 | _csv_traverse, |
| 1624 | _csv_clear, |
| 1625 | _csv_free |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1626 | }; |
| 1627 | |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1628 | PyMODINIT_FUNC |
Martin v. Löwis | 1a21451 | 2008-06-11 05:26:20 +0000 | [diff] [blame] | 1629 | PyInit__csv(void) |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1630 | { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1631 | PyObject *module; |
Serhiy Storchaka | 2d06e84 | 2015-12-25 19:53:18 +0200 | [diff] [blame] | 1632 | const StyleDesc *style; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1633 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1634 | if (PyType_Ready(&Reader_Type) < 0) |
| 1635 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1636 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1637 | if (PyType_Ready(&Writer_Type) < 0) |
| 1638 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1639 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1640 | /* Create the module and add the functions */ |
| 1641 | module = PyModule_Create(&_csvmodule); |
| 1642 | if (module == NULL) |
| 1643 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1644 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1645 | /* Add version to the module. */ |
| 1646 | if (PyModule_AddStringConstant(module, "__version__", |
| 1647 | MODULE_VERSION) == -1) |
| 1648 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1649 | |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1650 | /* Set the field limit */ |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 1651 | get_csv_state(module)->field_limit = 128 * 1024; |
Antoine Pitrou | e7672d3 | 2012-05-16 11:33:08 +0200 | [diff] [blame] | 1652 | /* Do I still need to add this var to the Module Dict? */ |
| 1653 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1654 | /* Add _dialects dictionary */ |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 1655 | get_csv_state(module)->dialects = PyDict_New(); |
| 1656 | if (get_csv_state(module)->dialects == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1657 | return NULL; |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 1658 | Py_INCREF(get_csv_state(module)->dialects); |
| 1659 | if (PyModule_AddObject(module, "_dialects", get_csv_state(module)->dialects)) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1660 | return NULL; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1661 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1662 | /* Add quote styles into dictionary */ |
| 1663 | for (style = quote_styles; style->name; style++) { |
| 1664 | if (PyModule_AddIntConstant(module, style->name, |
| 1665 | style->style) == -1) |
| 1666 | return NULL; |
| 1667 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1668 | |
Dong-hee Na | 37fcbb6 | 2020-03-25 07:08:51 +0900 | [diff] [blame] | 1669 | if (PyModule_AddType(module, &Dialect_Type)) { |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1670 | return NULL; |
Dong-hee Na | 37fcbb6 | 2020-03-25 07:08:51 +0900 | [diff] [blame] | 1671 | } |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1672 | |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1673 | /* Add the CSV exception object to the module. */ |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 1674 | get_csv_state(module)->error_obj = PyErr_NewException("_csv.Error", NULL, NULL); |
| 1675 | if (get_csv_state(module)->error_obj == NULL) |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1676 | return NULL; |
Hai Shi | f707d94 | 2020-03-16 21:15:01 +0800 | [diff] [blame] | 1677 | Py_INCREF(get_csv_state(module)->error_obj); |
| 1678 | PyModule_AddObject(module, "Error", get_csv_state(module)->error_obj); |
Antoine Pitrou | f95a1b3 | 2010-05-09 15:52:27 +0000 | [diff] [blame] | 1679 | return module; |
Skip Montanaro | b4a0417 | 2003-03-20 23:29:12 +0000 | [diff] [blame] | 1680 | } |