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
|
#ifndef AWS_CRT_PYTHON_MODULE_H
#define AWS_CRT_PYTHON_MODULE_H
/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
/**
* This file contains general helpers.
*/
#define PY_SSIZE_T_CLEAN 1
#include <Python.h>
#include <aws/common/common.h>
struct aws_byte_buf;
struct aws_byte_cursor;
struct aws_string;
#define AWS_CRT_PYTHON_PACKAGE_ID 10
/* Error codes, unique to aws-crt-python, for passing back to C layers */
enum aws_crt_python_errors {
AWS_ERROR_CRT_CALLBACK_EXCEPTION = AWS_ERROR_ENUM_BEGIN_RANGE(AWS_CRT_PYTHON_PACKAGE_ID),
AWS_ERROR_CRT_END_RANGE = AWS_ERROR_ENUM_END_RANGE(AWS_CRT_PYTHON_PACKAGE_ID)
};
/* AWS Specific Helpers */
PyObject *PyUnicode_FromAwsByteCursor(const struct aws_byte_cursor *cursor);
PyObject *PyUnicode_FromAwsString(const struct aws_string *aws_str);
/* Return the named attribute, converted to the specified type.
* If conversion cannot occur a python exception is set (check PyExc_Occurred()) */
uint32_t PyObject_GetAttrAsUint32(PyObject *o, const char *class_name, const char *attr_name);
uint16_t PyObject_GetAttrAsUint16(PyObject *o, const char *class_name, const char *attr_name);
uint8_t PyObject_GetAttrAsUint8(PyObject *o, const char *class_name, const char *attr_name);
bool PyObject_GetAttrAsBool(PyObject *o, const char *class_name, const char *attr_name);
int PyObject_GetAttrAsIntEnum(PyObject *o, const char *class_name, const char *attr_name);
/* Checks if the named attribute is None, converts it to the specified type, then stores
* the value and returns a pointer to the stored value or NULL if it doesn't exist or fails.
* If conversion cannot occur a python exception is set (check PyExc_Occurred()) */
uint64_t *PyObject_GetAsOptionalUint64(
PyObject *o,
const char *class_name,
const char *attr_name,
uint64_t *stored_int);
uint32_t *PyObject_GetAsOptionalUint32(
PyObject *o,
const char *class_name,
const char *attr_name,
uint32_t *stored_int);
uint16_t *PyObject_GetAsOptionalUint16(
PyObject *o,
const char *class_name,
const char *attr_name,
uint16_t *stored_int);
uint8_t *PyObject_GetAsOptionalUint8(PyObject *o, const char *class_name, const char *attr_name, uint8_t *stored_int);
bool *PyObject_GetAsOptionalBool(PyObject *o, const char *class_name, const char *attr_name, bool *stored_bool);
int *PyObject_GetAsOptionalIntEnum(PyObject *o, const char *class_name, const char *attr_name, int *stored_enum);
/* Create cursor from PyUnicode.
* If conversion cannot occur, cursor->ptr will be NULL and a python exception is set */
struct aws_byte_cursor aws_byte_cursor_from_pyunicode(PyObject *str);
/* Create cursor from PyBytes.
* If conversion cannot occur, cursor->ptr will be NULL and a python exception is set */
struct aws_byte_cursor aws_byte_cursor_from_pybytes(PyObject *py_bytes);
/* Set current thread's error indicator based on aws_last_error() */
void PyErr_SetAwsLastError(void);
/* Set current thread's error indicator based on aws_last_error() and returns NULL */
PyObject *PyErr_AwsLastError(void);
/**
* Return an AWS error code corresponding to the current Python error (fallback is AWS_ERROR_UNKNOWN).
*
* Prints the current Python error to stderr and clears the Python error indicator.
*
* The Python error indicator MUST be set and the GIL MUST be held when calling this function. */
int aws_py_translate_py_error(void);
/**
* Raise an AWS error corresponding to the current Python error.
*
* Prints the current Python error to stderr and clears the Python error indicator.
* Finds an AWS error code corresponding to the current Python error (fallback is AWS_ERROR_UNKNOWN).
* Invokes aws_raise_error() with that error code and always returns AWS_OP_ERR.
*
* The Python error indicator MUST be set and the GIL MUST be held when calling this function. */
int aws_py_raise_error(void);
/**
* Return built-in Python exception type corresponding to an AWS_ERROR_ code.
* Ex: AWS_ERROR_OOM -> MemoryError.
* Returns None if there is no match.
*/
PyObject *aws_py_get_corresponding_builtin_exception(PyObject *self, PyObject *args);
PyObject *aws_py_get_error_name(PyObject *self, PyObject *args);
PyObject *aws_py_get_error_message(PyObject *self, PyObject *args);
/* Create a write-only memoryview from the remaining free space in an aws_byte_buf */
PyObject *aws_py_memory_view_from_byte_buffer(struct aws_byte_buf *buf);
/* Allocator that calls into PyObject_[Malloc|Free|Realloc] */
struct aws_allocator *aws_py_get_allocator(void);
/**
* Acquire GIL, unless it is impossible to do so because the application is shutting down.
* Returns AWS_OP_ERR and raises AWS error if GIL cannot be acquired.
*
* Late in application shutdown, attempting to acquire GIL can crash the application.
* We encounter this situation if native resources are still running when the application exits.
* Python programmers are allowed to exist without shutting everything down, it does not make them criminals.
*
* If we encounter this situation, we must not crash the application while it finishes terminating.
* Do not interact with Python! It's ok not to fulfill promises (ex: it's ok if a completion callback never fires)
* because the user clearly no longer cares about the results.
*/
int aws_py_gilstate_ensure(PyGILState_STATE *out_state);
/* Return the capsule ptr from obj._binding
* On error, NULL is returned and a python exception is set. */
void *aws_py_get_binding(PyObject *obj, const char *capsule_name, const char *class_name);
/* Contents of aws_py_get_XYZ() function where obj._binding->native is returned.
* NOTE: only works where native is stored by ptr. */
#define AWS_PY_RETURN_NATIVE_FROM_BINDING(PYOBJ, CAPSULE_NAME, CLASS_NAME, BINDING_TYPE) \
struct BINDING_TYPE *binding = aws_py_get_binding((PYOBJ), (CAPSULE_NAME), (CLASS_NAME)); \
if (binding) { \
if (binding->native) { \
return binding->native; \
} \
PyErr_Format(PyExc_TypeError, "Expected valid '%s', but '_binding.native' is NULL", (CLASS_NAME)); \
} \
return NULL
/* Shorthand for `return &obj._binding->native;` */
#define AWS_PY_RETURN_NATIVE_REF_FROM_BINDING(PYOBJ, CAPSULE_NAME, CLASS_NAME, BINDING_TYPE) \
struct BINDING_TYPE *binding = aws_py_get_binding((PYOBJ), (CAPSULE_NAME), (CLASS_NAME)); \
if (!binding) { \
return NULL; \
} \
return &binding->native
#endif /* AWS_CRT_PYTHON_MODULE_H */
|
