1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947
|
// © Copyright 2020-2025 Mikołaj Kuranowski
// SPDX-License-Identifier: MIT
#include <assert.h>
#include <limits.h>
#include <stdbool.h>
#include <stdio.h>
#define PY_SSIZE_T_CLEAN
#include <Python.h>
#include <structmember.h>
#define FINISH_WITH(new_result) \
do { \
result = (new_result); \
goto ret; \
} while (0)
/// A character which can't appear in a string
#define NO_CHAR (Py_UCS4) - 1
// ************************
// * PYTHON API BACKPORTS *
// ************************
#if PY_VERSION_HEX < 0x030A0000
#define Py_TPFLAGS_IMMUTABLETYPE 0
#define Py_TPFLAGS_DISALLOW_INSTANTIATION 0
typedef enum {
PYGEN_RETURN = 0,
PYGEN_ERROR = -1,
PYGEN_NEXT = 1,
} PySendResult;
static inline PyObject* Py_NewRef(PyObject* o) {
Py_INCREF(o);
return o;
}
static PyObject* _fetch_stop_iteration_value(void) {
PyObject* exc_type;
PyObject* exc_value;
PyObject* exc_traceback;
PyErr_Fetch(&exc_type, &exc_value, &exc_traceback);
assert(exc_type);
assert(PyErr_ExceptionMatches(PyExc_StopIteration));
PyErr_NormalizeException(&exc_type, &exc_value, &exc_traceback);
assert(PyObject_TypeCheck(exc_value, (PyTypeObject*)PyExc_StopIteration));
PyErr_Clear();
PyObject* value = ((PyStopIterationObject*)exc_value)->value;
Py_INCREF(value);
Py_XDECREF(exc_type);
Py_XDECREF(exc_value);
Py_XDECREF(exc_traceback);
return value;
}
static PySendResult PyIter_Send(PyObject* iter, PyObject* arg, PyObject** presult) {
assert(arg);
assert(presult);
// Ensure arg is Py_None
if (arg != Py_None) {
PyErr_SetString(
PyExc_SystemError,
"aiocsv's PyIter_Send backport doesn't support sending values other than None");
return PYGEN_ERROR;
}
// Ensure iter is an iterator
if (!PyIter_Check(iter)) {
PyErr_Format(PyExc_TypeError, "%R is not an iterator", Py_TYPE(iter));
return PYGEN_ERROR;
}
*presult = (Py_TYPE(iter)->tp_iternext)(iter);
if (*presult) return PYGEN_NEXT;
if (!PyErr_ExceptionMatches(PyExc_StopIteration)) return PYGEN_ERROR;
*presult = _fetch_stop_iteration_value();
return PYGEN_RETURN;
}
#endif
#if PY_VERSION_HEX < 0x030D0000
static int PyModule_Add(PyObject* module, const char* name, PyObject* value) {
if (PyModule_AddObject(module, name, value) < 0) {
Py_XDECREF(value);
return -1;
}
return 0;
}
#endif
// ***************
// * DEFINITIONS *
// ***************
/// Data held by instances of the _parser module itself -
/// objects imported from the builtin `csv` and `io` modules.
typedef struct {
/// csv.Error exception class
PyObject* csv_error;
/// csv.field_size_limit `() -> int` function
PyObject* csv_field_size_limit;
/// io.DEFAULT_BUFFER_SIZE PyLongObject
PyObject* io_default_buffer_size;
/// The string "read"
PyObject* str_read;
} ModuleState;
/// Returns a ModuleState* from a Parser instance (Parser*)
#define parser_get_module_state(p) ((ModuleState*)PyType_GetModuleState(Py_TYPE(p)))
typedef enum {
QUOTE_MINIMAL = 0,
QUOTE_ALL = 1,
QUOTE_NON_NUMERIC = 2,
QUOTE_NONE = 3,
QUOTE_STRINGS = 4,
QUOTE_NOT_NULL = 5,
} Quoting;
typedef enum {
STATE_START_RECORD = 0,
STATE_START_FIELD,
STATE_IN_FIELD,
STATE_ESCAPE,
STATE_IN_QUOTED_FIELD,
STATE_ESCAPE_IN_QUOTED,
STATE_QUOTE_IN_QUOTED,
STATE_EAT_NEWLINE,
} ParserState;
static inline bool state_is_end_of_record(ParserState s) {
switch (s) {
case STATE_START_RECORD:
case STATE_EAT_NEWLINE:
return true;
default:
return false;
}
}
static inline bool state_is_unexpected_at_eof(ParserState s) {
switch (s) {
case STATE_ESCAPE:
case STATE_IN_QUOTED_FIELD:
case STATE_ESCAPE_IN_QUOTED:
return true;
default:
return false;
}
}
typedef enum {
/// Parsing should continue - row is not ready
DECISION_CONTINUE,
/// Parsing should stop - a row is ready
DECISION_DONE,
/// Parsing should stop - a row is ready.
/// Current char should not be removed from the buffer.
DECISION_DONE_WITHOUT_CONSUMING,
/// An error was encountered - parsing must halt immediately
DECISION_ERROR,
} Decision;
/// C-friendly container for dialect parameters.
typedef struct {
Py_UCS4 delimiter;
Py_UCS4 quotechar;
Py_UCS4 escapechar;
unsigned char quoting;
bool doublequote;
bool skipinitialspace;
bool strict;
} Dialect;
// Parser implements the outer AsyncIterator[List[str]] protocol (__aiter__ + __anext__),
// but, to avoid allocating new object on each call to __anext__, Parser returns itself from
// __anext__. So, Parser also implements Awaitable[List[str]] (which also returns itself) and
// Generator[Any, None, List[str]].
typedef struct {
// clang-format off
PyObject_HEAD
/// Anything with a `async def read(self, n: int) -> str` method.
PyObject* reader;
/// Generator[Any, None, str] if waiting for a read, NULL otherwise.
PyObject* current_read;
/// Data returned by the latest read, if not NULL must be in the canonical form.
PyObject* buffer_str;
/// Offset into buffer to the first valid character
Py_ssize_t buffer_idx;
/// list[str] with parsed fields from the current record. Lazily allocated, may be NULL.
PyObject* record_so_far;
/// PyMem-allocated buffer for characters of the current field.
Py_UCS4* field_so_far;
/// Capacity of `field_so_far`.
Py_ssize_t field_so_far_capacity;
/// Number of characters in `field_so_far`.
Py_ssize_t field_so_far_len;
/// C-friendly representation of the csv dialect.
Dialect dialect;
/// Limit for the field size
long field_size_limit;
/// Zero-based line number of the current position, which is equivalent to
/// a one-based line number of the last-encountered line.
unsigned int line_num;
/// ParserState for the parser state machine.
unsigned char state;
/// True if current field was quoted.
bool field_was_quoted;
/// True if last returned character was a CR, used to avoid counting CR-LF as two separate lines.
bool last_char_was_cr;
/// True if eof has been hit in the underlying reader.
bool eof;
// clang-format on
} Parser;
// **************************
// * DIALECT IMPLEMENTATION *
// **************************
#define dialect_init_char(d, o, attr_name) \
PyObject* attr_name = PyObject_GetAttrString((o), #attr_name); \
if (attr_name) { \
(d)->attr_name = PyUnicode_ReadChar(attr_name, 0); \
if (PyErr_Occurred()) { \
Py_DECREF(attr_name); \
return 0; \
} \
} else { \
PyErr_SetString(PyExc_AttributeError, "dialect has no attribute '" #attr_name "'"); \
return 0; \
} \
Py_DECREF(attr_name);
#define dialect_init_optional_char(d, o, attr_name) \
PyObject* attr_name = PyObject_GetAttrString((o), #attr_name); \
if (attr_name == Py_None) { \
(d)->attr_name = NO_CHAR; \
} else if (attr_name) { \
(d)->attr_name = PyUnicode_ReadChar(attr_name, 0); \
if (PyErr_Occurred()) { \
Py_DECREF(attr_name); \
return 0; \
} \
} else { \
PyErr_SetString(PyExc_AttributeError, "dialect has no attribute '" #attr_name "'"); \
return 0; \
} \
Py_DECREF(attr_name);
#define dialect_init_bool(d, o, attr_name) \
PyObject* attr_name = PyObject_GetAttrString((o), #attr_name); \
if (attr_name == NULL) { \
PyErr_SetString(PyExc_AttributeError, "dialect has no attribute '" #attr_name "'"); \
return 0; \
} \
(d)->attr_name = PyObject_IsTrue(attr_name); \
Py_DECREF(attr_name);
#define dialect_init_quoting(d, o) \
PyObject* quoting = PyObject_GetAttrString(o, "quoting"); \
if (quoting == NULL) { \
PyErr_SetString(PyExc_AttributeError, "dialect has no attribute 'quoting'"); \
return 0; \
} \
Py_ssize_t quoting_value = PyNumber_AsSsize_t(quoting, NULL); \
Py_DECREF(quoting); \
if (PyErr_Occurred()) { \
return 0; \
} \
if (quoting_value < (Py_ssize_t)QUOTE_MINIMAL || \
quoting_value > (Py_ssize_t)QUOTE_NOT_NULL) { \
PyErr_Format(PyExc_ValueError, "dialect.quoting: unexpected value %zd", quoting_value); \
return 0; \
} \
d->quoting = (unsigned char)quoting_value;
int Dialect_init(Dialect* d, PyObject* o) {
dialect_init_char(d, o, delimiter);
dialect_init_optional_char(d, o, quotechar);
dialect_init_optional_char(d, o, escapechar);
dialect_init_quoting(d, o);
dialect_init_bool(d, o, doublequote);
dialect_init_bool(d, o, skipinitialspace);
dialect_init_bool(d, o, strict);
return 1;
}
// *************************
// * PARSER IMPLEMENTATION *
// *************************
// *** PyObject Interface ***
static void Parser_dealloc(Parser* self) {
PyTypeObject* tp = Py_TYPE(self);
PyObject_GC_UnTrack(self);
tp->tp_clear((PyObject*)self);
if (self->field_so_far) {
PyMem_Free(self->field_so_far);
self->field_so_far = NULL;
}
PyObject_GC_Del(self);
Py_DECREF(tp);
}
static int Parser_traverse(Parser* self, visitproc visit, void* arg) {
Py_VISIT(self->reader);
Py_VISIT(self->current_read);
Py_VISIT(self->buffer_str);
Py_VISIT(self->record_so_far);
Py_VISIT(Py_TYPE(self));
return 0;
}
static int Parser_clear(Parser* self) {
Py_CLEAR(self->reader);
Py_CLEAR(self->current_read);
Py_CLEAR(self->record_so_far);
return 0;
}
static PyObject* Parser_new(PyTypeObject* subtype, PyObject* args, PyObject* kwargs) {
ModuleState* state = PyType_GetModuleState(subtype);
Parser* self = PyObject_GC_New(Parser, subtype);
if (!self) return NULL;
// Zero-initialize all custom Parser fields. In case the initialization fails,
// we need to ensure the deallocator doesn't stumble on garbage values.
self->reader = NULL;
self->current_read = NULL;
self->buffer_str = NULL;
self->buffer_idx = 0;
self->record_so_far = NULL;
self->field_so_far = NULL;
self->field_so_far_capacity = 0;
self->field_so_far_len = 0;
self->dialect = (Dialect){0};
self->field_size_limit = 0;
self->line_num = 0;
self->state = STATE_START_RECORD;
self->field_was_quoted = false;
self->last_char_was_cr = false;
self->eof = false;
PyObject* reader;
PyObject* dialect;
static char* kw_list[] = {"reader", "dialect", NULL};
if (!PyArg_ParseTupleAndKeywords(args, kwargs, "OO", kw_list, &reader, &dialect)) {
Py_DECREF(self);
return NULL;
}
if (!Dialect_init(&self->dialect, dialect)) {
Py_DECREF(self);
return NULL;
}
self->reader = Py_NewRef(reader);
PyObject* field_size_limit_obj = PyObject_CallObject(state->csv_field_size_limit, NULL);
if (!field_size_limit_obj) {
Py_DECREF(self);
return NULL;
}
self->field_size_limit = PyLong_AsLong(field_size_limit_obj);
Py_DECREF(field_size_limit_obj);
if (PyErr_Occurred()) {
Py_DECREF(self);
return NULL;
}
PyObject_GC_Track(self);
return (PyObject*)self;
}
// *** Parsing ***
static inline bool Parser_has_char(Parser const* self) {
return self->buffer_str && self->buffer_idx < PyUnicode_GET_LENGTH(self->buffer_str);
}
static int Parser_add_char(Parser* self, Py_UCS4 c) {
if (self->field_so_far_len == self->field_size_limit) {
PyObject* err = parser_get_module_state(self)->csv_error;
PyErr_Format(err, "field larger than field limit (%ld)", self->field_size_limit);
return 0;
} else if (self->field_so_far_len >= self->field_so_far_capacity) {
Py_ssize_t new_capacity =
self->field_so_far_capacity ? self->field_so_far_capacity * 2 : 4096;
Py_UCS4* new_buffer = self->field_so_far;
PyMem_Resize(new_buffer, Py_UCS4, new_capacity);
if (new_buffer == NULL) {
PyErr_NoMemory();
return 0;
}
self->field_so_far = new_buffer;
self->field_so_far_capacity = new_capacity;
}
assert(self->field_so_far_len < self->field_so_far_capacity);
self->field_so_far[self->field_so_far_len] = c;
++self->field_so_far_len;
return 1;
}
static Py_ssize_t find_first_non_space(Py_UCS4* str, Py_ssize_t len) {
Py_ssize_t i = 0;
while (i < len && Py_UNICODE_ISSPACE(str[i])) ++i;
return i;
}
static int Parser_save_field(Parser* self) {
// Ensure parser has a list
if (!self->record_so_far) {
self->record_so_far = PyList_New(0);
if (!self->record_so_far) return 0;
}
// Convert field_so_far to a PyUnicode object
PyObject* field = NULL;
if (self->dialect.skipinitialspace) {
Py_ssize_t offset = find_first_non_space(self->field_so_far, self->field_so_far_len);
field = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, self->field_so_far + offset,
self->field_so_far_len - offset);
} else {
field = PyUnicode_FromKindAndData(PyUnicode_4BYTE_KIND, self->field_so_far,
self->field_so_far_len);
}
if (!field) return 0;
self->field_so_far_len = 0;
// Cast the field to a float or None, if applicable
if (!self->field_was_quoted) {
// Check if this field should be converted to float or None
bool is_none = false;
bool is_float = false;
if (self->dialect.quoting == QUOTE_NON_NUMERIC) {
is_float = PyObject_IsTrue(field);
} else if (self->dialect.quoting == QUOTE_STRINGS) {
is_none = PyObject_Not(field);
is_float = !is_none;
} else if (self->dialect.quoting == QUOTE_NOT_NULL) {
is_none = PyObject_Not(field);
}
// Convert to None or float
if (is_none) {
Py_DECREF(field);
field = Py_NewRef(Py_None);
} else if (is_float) {
PyObject* field_as_float = PyFloat_FromString(field);
Py_DECREF(field);
if (!field_as_float) return 0;
field = field_as_float;
}
} else {
self->field_was_quoted = false;
}
// Append the field to the record
int failed = PyList_Append(self->record_so_far, field);
Py_DECREF(field);
// because fuck consistent error handling
// sometimes Python returns 0 on success (PyList_Append),
// sometimes Python returns 0 on failure (PyArg_*)
return !failed;
}
static inline int Parser_add_field_at_eof(Parser* self) {
if (self->state == STATE_ESCAPE || self->state == STATE_ESCAPE_IN_QUOTED) {
if (!Parser_add_char(self, '\n')) return 0;
}
if (!state_is_end_of_record(self->state)) return Parser_save_field(self);
return 1;
}
static inline PyObject* Parser_extract_record(Parser* self) {
PyObject* lst = self->record_so_far;
self->record_so_far = NULL;
return lst ? lst : PyList_New(0);
}
static Py_UCS4 Parser_get_char_and_increment_line_num(Parser* self) {
assert(self->buffer_str);
assert(self->buffer_idx < PyUnicode_GET_LENGTH(self->buffer_str));
Py_UCS4 c = PyUnicode_READ_CHAR(self->buffer_str, self->buffer_idx);
if (c == '\r') {
++self->line_num;
self->last_char_was_cr = true;
} else if (c == '\n') {
self->line_num += !self->last_char_was_cr; // increment if not part of a CRLF
self->last_char_was_cr = false;
} else {
self->last_char_was_cr = false;
}
return c;
}
static Decision Parser_process_char_in_eat_newline(Parser* self, Py_UCS4 c) {
self->state = STATE_START_RECORD;
return c == '\n' ? DECISION_DONE : DECISION_DONE_WITHOUT_CONSUMING;
}
static Decision Parser_process_char_in_quote_in_quoted(Parser* self, Py_UCS4 c) {
if (c == self->dialect.quotechar && self->dialect.quoting != QUOTE_NONE) {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
self->state = STATE_IN_QUOTED_FIELD;
return DECISION_CONTINUE;
} else if (c == self->dialect.delimiter) {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_START_FIELD;
return DECISION_CONTINUE;
} else if (c == '\r') {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_EAT_NEWLINE;
return DECISION_CONTINUE;
} else if (c == '\n') {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_START_RECORD;
return DECISION_DONE;
} else if (!self->dialect.strict) {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
self->state = STATE_IN_FIELD;
return DECISION_CONTINUE;
} else {
PyObject* csv_error = parser_get_module_state(self)->csv_error;
PyErr_Format(csv_error, "'%c' expected after '%c'", self->dialect.delimiter,
self->dialect.quotechar);
return DECISION_ERROR;
}
}
static Decision Parser_process_char_in_escape_in_quoted(Parser* self, Py_UCS4 c) {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
self->state = STATE_IN_QUOTED_FIELD;
return DECISION_CONTINUE;
}
static Decision Parser_process_char_in_quoted_field(Parser* self, Py_UCS4 c) {
if (c == self->dialect.escapechar) {
self->state = STATE_ESCAPE_IN_QUOTED;
return DECISION_CONTINUE;
} else if (c == self->dialect.quotechar && self->dialect.quoting != QUOTE_NONE) {
self->state = self->dialect.doublequote ? STATE_QUOTE_IN_QUOTED : STATE_IN_FIELD;
return DECISION_CONTINUE;
} else {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
return DECISION_CONTINUE;
}
}
static Decision Parser_process_char_in_escape(Parser* self, Py_UCS4 c) {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
self->state = STATE_IN_FIELD;
return DECISION_CONTINUE;
}
static Decision Parser_process_char_in_field(Parser* self, Py_UCS4 c) {
if (c == '\r') {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_EAT_NEWLINE;
return DECISION_CONTINUE;
} else if (c == '\n') {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_START_RECORD;
return DECISION_DONE;
} else if (c == self->dialect.escapechar) {
self->state = STATE_ESCAPE;
return DECISION_CONTINUE;
} else if (c == self->dialect.delimiter) {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_START_FIELD;
return DECISION_CONTINUE;
} else {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
// self->state = STATE_IN_FIELD; // already is STATE_IN_FIELD
return DECISION_CONTINUE;
}
}
static Decision Parser_process_char_in_start_field(Parser* self, Py_UCS4 c) {
if (c == '\r') {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_EAT_NEWLINE;
return DECISION_CONTINUE;
} else if (c == '\n') {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_START_RECORD;
return DECISION_DONE;
} else if (c == self->dialect.quotechar && self->dialect.quoting != QUOTE_NONE) {
self->field_was_quoted = true;
self->state = STATE_IN_QUOTED_FIELD;
return DECISION_CONTINUE;
} else if (c == self->dialect.escapechar) {
self->state = STATE_ESCAPE;
return DECISION_CONTINUE;
} else if (c == self->dialect.delimiter) {
if (!Parser_save_field(self)) return DECISION_ERROR;
self->state = STATE_START_FIELD;
return DECISION_CONTINUE;
} else {
if (!Parser_add_char(self, c)) return DECISION_ERROR;
self->state = STATE_IN_FIELD;
return DECISION_CONTINUE;
}
}
static Decision Parser_process_char_in_start_record(Parser* self, Py_UCS4 c) {
if (c == '\r') {
self->state = STATE_EAT_NEWLINE;
return DECISION_CONTINUE;
} else if (c == '\n') {
self->state = STATE_START_RECORD;
return DECISION_DONE;
} else {
return Parser_process_char_in_start_field(self, c);
}
}
static Decision Parser_process_char(Parser* self, Py_UCS4 c) {
switch ((ParserState)self->state) {
case STATE_START_RECORD:
return Parser_process_char_in_start_record(self, c);
case STATE_START_FIELD:
return Parser_process_char_in_start_field(self, c);
case STATE_IN_FIELD:
return Parser_process_char_in_field(self, c);
case STATE_ESCAPE:
return Parser_process_char_in_escape(self, c);
case STATE_IN_QUOTED_FIELD:
return Parser_process_char_in_quoted_field(self, c);
case STATE_ESCAPE_IN_QUOTED:
return Parser_process_char_in_escape_in_quoted(self, c);
case STATE_QUOTE_IN_QUOTED:
return Parser_process_char_in_quote_in_quoted(self, c);
case STATE_EAT_NEWLINE:
return Parser_process_char_in_eat_newline(self, c);
}
Py_UNREACHABLE();
}
static PyObject* Parser_try_parse(Parser* self) {
Decision decision = DECISION_CONTINUE;
while (decision == DECISION_CONTINUE && Parser_has_char(self)) {
Py_UCS4 c = Parser_get_char_and_increment_line_num(self);
decision = Parser_process_char(self, c);
if (decision == DECISION_ERROR) {
if (!PyErr_Occurred()) {
PyErr_Format(PyExc_SystemError,
"Parser_process_char (state %d) returned DECISION_ERROR without "
"setting an exception",
(int)self->state);
}
return NULL;
}
if (decision != DECISION_DONE_WITHOUT_CONSUMING) ++self->buffer_idx;
}
if (decision != DECISION_CONTINUE || (self->eof && !state_is_end_of_record(self->state))) {
if (self->dialect.strict && state_is_unexpected_at_eof(self->state)) {
PyErr_SetString(parser_get_module_state(self)->csv_error, "unexpected end of data");
return NULL;
}
Parser_add_field_at_eof(self);
return Parser_extract_record(self);
}
return NULL;
}
// *** Reading Data ***
static int Parser_initiate_read(Parser* self) {
assert(!self->current_read);
PyObject* read_coro = NULL;
int result = 1;
ModuleState* module_state = parser_get_module_state(self);
read_coro = PyObject_CallMethodOneArg(self->reader, module_state->str_read,
module_state->io_default_buffer_size);
if (!read_coro) FINISH_WITH(0);
PyAsyncMethods* coro_async_methods = Py_TYPE(read_coro)->tp_as_async;
if (!coro_async_methods || !coro_async_methods->am_await) {
PyErr_Format(PyExc_TypeError, "reader.read returned %R, which is not awaitable",
read_coro);
FINISH_WITH(0);
}
self->current_read = coro_async_methods->am_await(read_coro);
result = self->current_read ? 1 : 0;
ret:
Py_XDECREF(read_coro);
return result;
}
static int Parser_finalize_read(Parser* self, PyObject* unicode) {
int result = 1;
// Clear any existing str
self->buffer_idx = 0;
if (self->buffer_str) {
Py_DECREF(self->buffer_str);
self->buffer_str = NULL;
}
// Ensure the result is a valid unicode object in canonical form
if (!PyUnicode_Check(unicode)) {
PyErr_Format(PyExc_TypeError, "reader.read() returned %R, expected str", Py_TYPE(unicode));
FINISH_WITH(0);
}
if (PyUnicode_READY(unicode)) {
FINISH_WITH(0);
}
Py_ssize_t len = PyUnicode_GET_LENGTH(unicode);
assert(len >= 0);
if (len == 0) {
// No more data - hit EOF
self->eof = true;
} else {
// More data - move it to buffer_str
self->buffer_str = unicode;
unicode = NULL;
}
ret:
Py_XDECREF(unicode);
return result;
}
static PyObject* Parser_next(Parser* self) {
// Loop until a record has been successfully parsed or EOF has been hit
PyObject* record = NULL;
while (!record && (self->buffer_str || !self->eof)) {
// No pending read and no data available - initiate a read
if (!Parser_has_char(self) && self->current_read == NULL) {
if (!Parser_initiate_read(self)) return NULL;
}
// Await on the pending read
if (self->current_read) {
PyObject* read_str;
switch (PyIter_Send(self->current_read, Py_None, &read_str)) {
case PYGEN_RETURN:
break;
case PYGEN_ERROR:
return NULL;
case PYGEN_NEXT:
return read_str;
}
Py_DECREF(self->current_read);
self->current_read = NULL;
if (!Parser_finalize_read(self, read_str)) return NULL;
}
// Advance parsing
record = Parser_try_parse(self);
if (PyErr_Occurred()) return NULL;
}
// Generate a row or stop iteration altogether
if (record) {
PyErr_SetObject(PyExc_StopIteration, record);
Py_DECREF(record);
} else {
PyErr_SetNone(PyExc_StopAsyncIteration);
}
return NULL;
}
// *** Type Specification ***
// TODO: Once support 3.8 is dropped, the "Parser" function can be replaced by
// normal .tp_new and .tp_init members on the "_Parser" type.
// Starting with 3.9 it's possible to access modules state from the _Parser type
// with PyType_GetModuleState, but on 3.8 the module needs to be passed around directly
// from the fake constructor-function.
static PyMemberDef ParserMembers[] = {
{"line_num", T_UINT, offsetof(Parser, line_num), READONLY,
"Line number of the recently-returned row"},
{NULL},
};
static PyType_Slot ParserSlots[] = {
{Py_tp_doc, "Asynchronous Iterator of CSV records from a reader"},
{Py_tp_traverse, Parser_traverse},
{Py_tp_clear, Parser_clear},
{Py_tp_dealloc, Parser_dealloc},
{Py_tp_members, ParserMembers},
{Py_tp_new, Parser_new},
{Py_am_await, Py_NewRef}, // Return "self" unchanged
{Py_am_aiter, Py_NewRef}, // Return "self" unchanged
{Py_am_anext, Py_NewRef}, // Return "self" unchanged
{Py_tp_iter, Py_NewRef}, // Return "self" unchanged
{Py_tp_iternext, Parser_next},
{0, NULL},
};
static PyType_Spec ParserSpec = {
.name = "_parser._Parser",
.basicsize = sizeof(Parser),
.itemsize = 0,
.flags = (Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | Py_TPFLAGS_IMMUTABLETYPE),
.slots = ParserSlots,
};
// *************************
// * MODULE IMPLEMENTATION *
// *************************
static int module_clear(PyObject* module) {
ModuleState* state = PyModule_GetState(module);
if (state) {
Py_CLEAR(state->csv_error);
Py_CLEAR(state->csv_field_size_limit);
Py_CLEAR(state->io_default_buffer_size);
Py_CLEAR(state->str_read);
}
return 0;
}
static int module_traverse(PyObject* module, visitproc visit, void* arg) {
ModuleState* state = PyModule_GetState(module);
if (state) {
Py_VISIT(state->csv_error);
Py_VISIT(state->csv_field_size_limit);
Py_VISIT(state->io_default_buffer_size);
Py_VISIT(state->str_read);
}
return 0;
}
static void module_free(void* module) { module_clear((PyObject*)module); }
static int module_exec(PyObject* module) {
int result = 0;
PyObject* csv_module = NULL;
PyObject* io_module = NULL;
ModuleState* state = PyModule_GetState(module);
state->str_read = PyUnicode_InternFromString("read");
if (!state->str_read) FINISH_WITH(-1);
csv_module = PyImport_ImportModule("csv");
if (!csv_module) FINISH_WITH(-1);
state->csv_error = PyObject_GetAttrString(csv_module, "Error");
if (!state->csv_error) FINISH_WITH(-1);
state->csv_field_size_limit = PyObject_GetAttrString(csv_module, "field_size_limit");
if (!state->csv_field_size_limit) FINISH_WITH(-1);
io_module = PyImport_ImportModule("io");
if (!io_module) FINISH_WITH(-1);
state->io_default_buffer_size = PyObject_GetAttrString(io_module, "DEFAULT_BUFFER_SIZE");
if (!state->io_default_buffer_size) FINISH_WITH(-1);
long io_default_buffer_size_value = PyLong_AsLong(state->io_default_buffer_size);
if (PyErr_Occurred()) FINISH_WITH(-1);
if (io_default_buffer_size_value <= 0) {
PyErr_Format(PyExc_ValueError,
"io.DEFAULT_BUFFER_SIZE is %ld, expected a positive integer",
state->io_default_buffer_size);
FINISH_WITH(-1);
}
if (PyModule_Add(module, "Parser", PyType_FromModuleAndSpec(module, &ParserSpec, NULL)))
FINISH_WITH(-1);
ret:
Py_XDECREF(csv_module);
Py_XDECREF(io_module);
return result;
}
static PyModuleDef_Slot ModuleSlots[] = {
{Py_mod_exec, module_exec},
#if PY_VERSION_HEX >= 0x030C0000
{Py_mod_multiple_interpreters, Py_MOD_PER_INTERPRETER_GIL_SUPPORTED},
#endif
{0, NULL},
};
static PyModuleDef ModuleDef = {
.m_base = PyModuleDef_HEAD_INIT,
.m_name = "_parser",
.m_doc = "_parser implements asynchronous CSV record parsing",
.m_size = sizeof(ModuleState),
.m_slots = ModuleSlots,
.m_traverse = module_traverse,
.m_clear = module_clear,
.m_free = module_free,
};
PyMODINIT_FUNC PyInit__parser(void) { return PyModuleDef_Init(&ModuleDef); }
|