CBOR bindings (#559)

Author: TingDaoK

.gitignore

@@ -386,12 +386,7 @@ poetry.toml
 pyrightconfig.json
 
 ### VisualStudioCode ###
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
-!.vscode/*.code-snippets
+.vscode
 
 # Local History for Visual Studio Code
 .history/

awscrt/cbor.py

@@ -0,0 +1,56 @@
+#ifndef AWS_CRT_PYTHON_CBOR_H
+#define AWS_CRT_PYTHON_CBOR_H
+/**
+ * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+ * SPDX-License-Identifier: Apache-2.0.
+ */
+#include "module.h"
+
+/*******************************************************************************
+ * ENCODE
+ ******************************************************************************/
+
+PyObject *aws_py_cbor_encoder_new(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_get_encoded_data(PyObject *self, PyObject *args);
+
+PyObject *aws_py_cbor_encoder_write_uint(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_negint(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_float(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_bytes(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_text(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_array_start(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_map_start(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_tag(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_bool(PyObject *self, PyObject *args);
+
+/* Encode the types without value needed. The arg is the type to encode. */
+PyObject *aws_py_cbor_encoder_write_simple_types(PyObject *self, PyObject *args);
+
+PyObject *aws_py_cbor_encoder_write_py_list(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_py_dict(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_encoder_write_data_item(PyObject *self, PyObject *args);
+
+/*******************************************************************************
+ * DECODE
+ ******************************************************************************/
+
+PyObject *aws_py_cbor_decoder_new(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_peek_type(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_get_remaining_bytes_len(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_consume_next_element(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_consume_next_data_item(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_unsigned_int(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_negative_int(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_float(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_boolean(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_bytes(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_text(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_array_start(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_map_start(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_tag(PyObject *self, PyObject *args);
+
+PyObject *aws_py_cbor_decoder_pop_next_py_list(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_py_dict(PyObject *self, PyObject *args);
+PyObject *aws_py_cbor_decoder_pop_next_data_item(PyObject *self, PyObject *args);
+
+#endif /* AWS_CRT_PYTHON_CBOR_H */

source/cbor.c

@@ -5,6 +5,7 @@
 #include "module.h"
 
 #include "auth.h"
+#include "cbor.h"
 #include "checksums.h"
 #include "common.h"
 #include "crypto.h"
@@ -117,6 +118,14 @@ PyObject *PyUnicode_FromAwsString(const struct aws_string *aws_str) {
     return PyUnicode_FromStringAndSize(aws_string_c_str(aws_str), aws_str->len);
 }
 
+PyObject *PyBytes_FromAwsByteCursor(const struct aws_byte_cursor *cursor) {
+    if (cursor->len > PY_SSIZE_T_MAX) {
+        PyErr_SetString(PyExc_OverflowError, "Cursor exceeds PY_SSIZE_T_MAX");
+        return NULL;
+    }
+    return PyBytes_FromStringAndSize((const char *)cursor->ptr, (Py_ssize_t)cursor->len);
+}
+
 uint32_t PyObject_GetAttrAsUint32(PyObject *o, const char *class_name, const char *attr_name) {
     uint32_t result = UINT32_MAX;
 
@@ -899,6 +908,41 @@ static PyMethodDef s_module_methods[] = {
     AWS_PY_METHOD_DEF(websocket_increment_read_window, METH_VARARGS),
     AWS_PY_METHOD_DEF(websocket_create_handshake_request, METH_VARARGS),
 
+    /* CBOR Encode */
+    AWS_PY_METHOD_DEF(cbor_encoder_new, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_get_encoded_data, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_uint, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_negint, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_float, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_bytes, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_text, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_array_start, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_map_start, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_tag, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_bool, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_simple_types, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_py_list, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_py_dict, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_encoder_write_data_item, METH_VARARGS),
+
+    /* CBOR Decode */
+    AWS_PY_METHOD_DEF(cbor_decoder_new, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_peek_type, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_get_remaining_bytes_len, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_consume_next_element, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_consume_next_data_item, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_unsigned_int, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_negative_int, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_float, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_boolean, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_bytes, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_text, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_array_start, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_map_start, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_tag, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_py_list, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_py_dict, METH_VARARGS),
+    AWS_PY_METHOD_DEF(cbor_decoder_pop_next_data_item, METH_VARARGS),
     {NULL, NULL, 0, NULL},
 };
 

source/cbor.h

@@ -30,6 +30,7 @@ enum aws_crt_python_errors {
 /* AWS Specific Helpers */
 PyObject *PyUnicode_FromAwsByteCursor(const struct aws_byte_cursor *cursor);
 PyObject *PyUnicode_FromAwsString(const struct aws_string *aws_str);
+PyObject *PyBytes_FromAwsByteCursor(const struct aws_byte_cursor *cursor);
 
 /* Return the named attribute, converted to the specified type.
  * If conversion cannot occur a python exception is set (check PyExc_Occurred()) */