[compat] numpy 1.x and 2.x compatibility macros

Author: fangq

src/decoder.c

@@ -26,6 +26,18 @@
 #include "decoder.h"
 #include "python_funcs.h"
 
+/******************************************************************************/
+/* NumPy 1.x/2.x compatibility macros */
+/******************************************************************************/
+
+#ifndef PyDataType_ELSIZE
+    #define PyDataType_ELSIZE(d) ((d)->elsize)
+#endif
+
+#ifndef PyDataType_TYPE_NUM
+    #define PyDataType_TYPE_NUM(d) ((d)->type_num)
+#endif
+
 /******************************************************************************/
 
 #define RECURSE_AND_RETURN_OR_BAIL(action, recurse_msg) {\
@@ -150,9 +162,6 @@ static _soa_schema_t* _decode_soa_schema(_bjdata_decoder_buffer_t* buffer);
 
 /******************************************************************************/
 
-/* Returns new decoder buffer or NULL on failure (an exception will be set). Input must either support buffer interface
- * or be callable. Currently only increases reference count for input parameter.
- */
 _bjdata_decoder_buffer_t* _bjdata_decoder_buffer_create(_bjdata_decoder_prefs_t* prefs, PyObject* input,
         PyObject* seek) {
     _bjdata_decoder_buffer_t* buffer;
@@ -198,26 +207,19 @@ _bjdata_decoder_buffer_t* _bjdata_decoder_buffer_create(_bjdata_decoder_prefs_t*
     return NULL;
 }
 
-// Returns non-zero if buffer cleanup/finalisation failed and no other exception was set already
 int _bjdata_decoder_buffer_free(_bjdata_decoder_buffer_t** buffer) {
     int failed = 0;
 
     if (NULL != buffer && NULL != *buffer) {
         if ((*buffer)->view_set) {
-            // In buffered mode, rewind to position in stream up to which actually read (rather than buffered)
             if (NULL != (*buffer)->seek && (*buffer)->view.len > (*buffer)->pos) {
                 PyObject* type, *value, *traceback, *seek_result;
 
-                // preserve the previous exception, if set
                 PyErr_Fetch(&type, &value, &traceback);
                 seek_result = PyObject_CallFunction((*buffer)->seek, "nn",
                                                     ((*buffer)->pos - (*buffer)->view.len), IO_SEEK_CUR);
                 Py_XDECREF(seek_result);
 
-                /* Blindly calling PyErr_Restore would clear any exception raised by seek call. If however already had
-                 * an error before freeing buffer (this function), propagate that instead. (I.e. this behaves like a
-                 * nested try-except block.
-                 */
                 if (NULL != type) {
                     PyErr_Restore(type, value, traceback);
                 } else if (NULL == seek_result) {
@@ -243,15 +245,6 @@ int _bjdata_decoder_buffer_free(_bjdata_decoder_buffer_t** buffer) {
     return failed;
 }
 
-/* Tries to read len bytes from input, returning read chunk. Len is updated to how many bytes were actually read.
- * If not NULL, dst_buffer can be an existing buffer to output len bytes into.
- * Returns NULL if either no input is left (len is set to zero) or an error occurs (len is non-zero). The caller must
- * NOT modify or free the returned chunk unless they specified out_buffer (in which case that is returned). When this
- * function is called again, the previously returned output is no longer valid (unless was created by caller).
- *
- * This function reads from a fixed buffer (single byte array)
- */
-
 static const char* _decoder_buffer_read_fixed(_bjdata_decoder_buffer_t* buffer, Py_ssize_t* len, char* dst_buffer) {
     Py_ssize_t old_pos;
 
@@ -2169,4 +2162,4 @@ int _bjdata_decoder_init(void) {
 void _bjdata_decoder_cleanup(void) {
     Py_CLEAR(DecoderException);
     Py_CLEAR(PyDec_Type);
-}
+}

src/encoder.c

@@ -27,6 +27,18 @@
 #include "encoder.h"
 #include "python_funcs.h"
 
+/******************************************************************************/
+/* NumPy 1.x/2.x compatibility macros */
+/******************************************************************************/
+
+#ifndef PyDataType_ELSIZE
+    #define PyDataType_ELSIZE(d) ((d)->elsize)
+#endif
+
+#ifndef PyDataType_TYPE_NUM
+    #define PyDataType_TYPE_NUM(d) ((d)->type_num)
+#endif
+
 /******************************************************************************/
 
 static char bytes_array_prefix[] = {ARRAY_START, CONTAINER_TYPE, TYPE_BYTE, CONTAINER_COUNT};
@@ -326,7 +338,7 @@ static inline int _is_string_type(int type_num) {
 
 /* Recursively check if a dtype is supported for SOA encoding */
 static int _is_soa_compatible_dtype(PyArray_Descr* fd) {
-    int type_num = fd->type_num;
+    int type_num = PyDataType_TYPE_NUM(fd);
 
     /* String types are supported */
     if (_is_string_type(type_num)) {
@@ -468,7 +480,7 @@ static int _encode_field_name(PyObject* name, _bjdata_encoder_buffer_t* buffer)
 
 /* Write schema for a field recursively (handles nested structs) */
 static int _write_field_schema_recursive(PyArray_Descr* fd, _bjdata_encoder_buffer_t* buffer) {
-    int type_num = fd->type_num;
+    int type_num = PyDataType_TYPE_NUM(fd);
     Py_ssize_t i;
 
     /* Handle NPY_VOID: could be sub-array or nested struct */
@@ -488,7 +500,7 @@ static int _write_field_schema_recursive(PyArray_Descr* fd, _bjdata_encoder_buff
                 }
             }
 
-            int base_type = base_dtype->type_num;
+            int base_type = PyDataType_TYPE_NUM(base_dtype);
             Py_DECREF(subdtype);
 
             /* Write sub-array schema: [TTT...] */
@@ -576,7 +588,7 @@ static int _write_field_schema_recursive(PyArray_Descr* fd, _bjdata_encoder_buff
     /* String types - write NUMPY BYTE SIZE (not character count) */
     if (_is_string_type(type_num)) {
         WRITE_CHAR_OR_BAIL(TYPE_STRING);
-        BAIL_ON_NONZERO(_encode_longlong(fd->elsize, buffer));
+        BAIL_ON_NONZERO(_encode_longlong(PyDataType_ELSIZE(fd), buffer));
         return 0;
     }
 
@@ -916,9 +928,9 @@ static int _encode_soa(PyArrayObject* arr, _bjdata_encoder_buffer_t* buffer, int
 
         PyArray_Descr* fd = (PyArray_Descr*)PyTuple_GET_ITEM(info, 0);
         field_offset[i] = PyLong_AsSsize_t(PyTuple_GET_ITEM(info, 1));
-        field_itemsize[i] = fd->elsize;
+        field_itemsize[i] = PyDataType_ELSIZE(fd);
 
-        int type_num = fd->type_num;
+        int type_num = PyDataType_TYPE_NUM(fd);
 
         if (type_num == NPY_BOOL) {
             field_type[i] = 1;