#include <Python.h>
#include <frameobject.h>
#include "BLI_utildefines.h"
#include "py_capi_utils.h"
#include "python_utildefines.h"
#include "MEM_guardedalloc.h"
#include "BLI_string.h"
#include "BLI_string_utf8.h"

Macros
#define	PY_SSIZE_T_CLEAN

Functions
Fast Python to C Array Conversion for Primitive Types
int	PyC_AsArray_FAST (void array, PyObject value_fast, const Py_ssize_t length, const PyTypeObject type, const bool is_double, const char error_prefix)

int	PyC_AsArray (void array, PyObject value, const Py_ssize_t length, const PyTypeObject type, const bool is_double, const char error_prefix)

Typed Tuple Packing
Note See #PyC_Tuple_Pack_* macros that take multiple arguments.
PyObject *	PyC_Tuple_PackArray_F32 (const float *array, uint len)

PyObject *	PyC_Tuple_PackArray_F64 (const double *array, uint len)

PyObject *	PyC_Tuple_PackArray_I32 (const int *array, uint len)

PyObject *	PyC_Tuple_PackArray_I32FromBool (const int *array, uint len)

PyObject *	PyC_Tuple_PackArray_Bool (const bool *array, uint len)

Tuple/List Filling
void	PyC_Tuple_Fill (PyObject tuple, PyObject value)

void	PyC_List_Fill (PyObject list, PyObject value)

Bool/Enum Argument Parsing
int	PyC_ParseBool (PyObject o, void p)

int	PyC_ParseStringEnum (PyObject o, void p)

const char *	PyC_StringEnum_FindIDFromValue (const struct PyC_StringEnumItems *items, const int value)

int	PyC_CheckArgs_DeepCopy (PyObject *args)

Simple Printing (for debugging)
These are useful to run directly from a debugger to be able to inspect the state.
void	PyC_ObSpit (const char name, PyObject var)

void	PyC_ObSpitStr (char result, size_t result_len, PyObject var)

void	PyC_LineSpit (void)

void	PyC_StackSpit (void)

Access Current Frame File Name & Line Number
void	PyC_FileAndNum (const char *r_filename, int r_lineno)

void	PyC_FileAndNum_Safe (const char *r_filename, int r_lineno)

Object Access Utilities
PyObject *	PyC_Object_GetAttrStringArgs (PyObject *o, Py_ssize_t n,...)

Frozen Set Creation
PyObject *	PyC_FrozenSetFromStrings (const char **strings)

Exception Utilities
PyObject *	PyC_Err_Format_Prefix (PyObject exception_type_prefix, const char format,...)

PyObject *	PyC_Err_SetString_Prefix (PyObject exception_type_prefix, const char str)

void	PyC_Err_PrintWithFunc (PyObject *py_func)

Exception Buffer Access
static void	pyc_exception_buffer_handle_system_exit (PyObject error_type, PyObject error_value, PyObject *error_traceback)

PyObject *	PyC_ExceptionBuffer (void)

PyObject *	PyC_ExceptionBuffer_Simple (void)

Unicode Conversion
In some cases we need to coerce strings, avoid doing this inline.
const char *	PyC_UnicodeAsByteAndSize (PyObject py_str, Py_ssize_t size, PyObject **coerce)

const char *	PyC_UnicodeAsByte (PyObject py_str, PyObject *coerce)

PyObject *	PyC_UnicodeFromByteAndSize (const char *str, Py_ssize_t size)

PyObject *	PyC_UnicodeFromByte (const char *str)

Name Space Creation/Manipulation
PyObject *	PyC_DefaultNameSpace (const char *filename)

bool	PyC_NameSpace_ImportArray (PyObject py_dict, const char imports[])

void	PyC_MainModule_Backup (PyObject **r_main_mod)

void	PyC_MainModule_Restore (PyObject *main_mod)

bool	PyC_IsInterpreterActive (void)

#Py_SetPythonHome Wrapper
void	PyC_RunQuicky (const char *filepath, int n,...)

void *	PyC_RNA_AsPointer (PyObject value, const char type_name)

Flag Set Utilities (#PyC_FlagSet)
Convert to/from Python set of strings to an int flag.
PyObject *	PyC_FlagSet_AsString (PyC_FlagSet *item)

int	PyC_FlagSet_ValueFromID_int (PyC_FlagSet item, const char identifier, int *r_value)

int	PyC_FlagSet_ValueFromID (PyC_FlagSet item, const char identifier, int r_value, const char error_prefix)

int	PyC_FlagSet_ToBitfield (PyC_FlagSet items, PyObject value, int r_value, const char error_prefix)

PyObject *	PyC_FlagSet_FromBitfield (PyC_FlagSet *items, int flag)

Run String (Evaluate to Primitive Types)
bool	PyC_RunString_AsNumber (const char imports[], const char expr, const char filename, double r_value)

bool	PyC_RunString_AsIntPtr (const char imports[], const char expr, const char filename, intptr_t r_value)

bool	PyC_RunString_AsStringAndSize (const char imports[], const char expr, const char filename, char r_value, size_t r_value_size)

bool	PyC_RunString_AsString (const char imports[], const char expr, const char filename, char *r_value)

Int Conversion
Note Python doesn't provide overflow checks for specific bit-widths.
int	PyC_Long_AsBool (PyObject *value)

int8_t	PyC_Long_AsI8 (PyObject *value)

int16_t	PyC_Long_AsI16 (PyObject *value)

uint8_t	PyC_Long_AsU8 (PyObject *value)

uint16_t	PyC_Long_AsU16 (PyObject *value)

uint32_t	PyC_Long_AsU32 (PyObject *value)

Py_buffer Utils
char	PyC_StructFmt_type_from_str (const char *typestr)

bool	PyC_StructFmt_type_is_float_any (char format)

bool	PyC_StructFmt_type_is_int_any (char format)

bool	PyC_StructFmt_type_is_byte (char format)

bool	PyC_StructFmt_type_is_bool (char format)

Detailed Description

Extend upon CPython's API, filling in some gaps, these functions use PyC_ prefix to distinguish them apart from CPython.

Note: This module should only depend on CPython, however it currently uses BLI_string_utf8() for unicode conversion.

Definition in file py_capi_utils.c.

Macro Definition Documentation

◆ PY_SSIZE_T_CLEAN

#define PY_SSIZE_T_CLEAN

Definition at line 29 of file py_capi_utils.c.

Function Documentation

◆ PyC_AsArray()

int PyC_AsArray	(	void *	array,
		PyObject *	value,
		const Py_ssize_t	length,
		const PyTypeObject *	type,
		const bool	is_double,
		const char *	error_prefix
	)

Definition at line 125 of file py_capi_utils.c.

References length(), PyC_AsArray_FAST(), ret, and type.

Referenced by BPy_BoolVectorProperty(), BPy_FloatVectorProperty(), bpy_gizmo_target_set_value(), BPy_IDArray_ass_slice(), BPy_IntVectorProperty(), bpy_prop_boolean_array_get_fn(), bpy_prop_float_array_get_fn(), bpy_prop_int_array_get_fn(), py_imbuf_ppm_set(), py_rna_gizmo_handler_get_cb(), pygpu_texture__tp_new(), and pygpu_texture_clear().

◆ PyC_AsArray_FAST()

int PyC_AsArray_FAST	(	void *	array,
		PyObject *	value_fast,
		const Py_ssize_t	length,
		const PyTypeObject *	type,
		const bool	is_double,
		const char *	error_prefix
	)

Definition at line 59 of file py_capi_utils.c.

References BLI_assert, length(), and type.

Referenced by PyC_AsArray(), pygpu_IndexBuf__tp_new(), pygpu_shader_uniform_bool(), and pygpu_shader_uniform_int().

◆ PyC_CheckArgs_DeepCopy()

int PyC_CheckArgs_DeepCopy ( PyObject * args )

Definition at line 297 of file py_capi_utils.c.

Referenced by Color_deepcopy(), Euler_deepcopy(), Matrix_deepcopy(), py_imbuf_deepcopy(), Quaternion_deepcopy(), and Vector_deepcopy().

◆ PyC_DefaultNameSpace()

PyObject* PyC_DefaultNameSpace ( const char * filename )

Definition at line 876 of file py_capi_utils.c.

References PyC_UnicodeFromByte().

Referenced by bpy_rna_uilayout_introspect(), bpy_run_string_impl(), PyC_RunQuicky(), PyC_RunString_AsIntPtr(), PyC_RunString_AsNumber(), PyC_RunString_AsStringAndSize(), and python_script_exec().

◆ PyC_Err_Format_Prefix()

PyObject* PyC_Err_Format_Prefix	(	PyObject *	exception_type_prefix,
		const char *	format,
			...
	)

Similar to #PyErr_Format(),

Implementation - we cant actually prepend the existing exception, because it could have any arguments given to it, so instead we get its __str__ output and raise our own exception including it.

Definition at line 530 of file py_capi_utils.c.

References NULL.

Referenced by bpy_class_call(), PyC_Err_SetString_Prefix(), and pyrna_py_to_prop().