#include <Python.h>
#include <string>
#include "BLI_compiler_attrs.h"
#include "BLI_span.hh"
#include "BLI_sys_types.h"

Classes
struct	PyC_UnicodeAsBytesAndSize_Data
struct	PyC_FlagSet
struct	PyC_StringEnumItems
struct	PyC_StringEnum

Functions
void	PyC_ObSpit (const char name, PyObject var)
void	PyC_ObSpitStr (char result, size_t result_maxncpy, PyObject var)
void	PyC_LineSpit ()
void	PyC_StackSpit ()
PyObject *	PyC_ExceptionBuffer () ATTR_RETURNS_NONNULL
PyObject *	PyC_ExceptionBuffer_Simple () ATTR_RETURNS_NONNULL
PyObject *	PyC_Object_GetAttrStringArgs (PyObject *o, Py_ssize_t n,...)
PyObject *	PyC_FrozenSetFromStrings (const char **strings)
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)
void	PyC_FileAndNum (const char *r_filename, int r_lineno)
void	PyC_FileAndNum_Safe (const char *r_filename, int r_lineno)
int	PyC_AsArray_FAST (void array, size_t array_item_size, PyObject value_fast, Py_ssize_t length, const PyTypeObject type, const char error_prefix)
int	PyC_AsArray (void array, size_t array_item_size, PyObject value, Py_ssize_t length, const PyTypeObject type, const char error_prefix)
int	PyC_AsArray_Multi_FAST (void array, size_t array_item_size, PyObject value_fast, const int dims, int dims_len, const PyTypeObject type, const char *error_prefix)
int	PyC_AsArray_Multi (void array, size_t array_item_size, PyObject value, const int dims, int dims_len, const PyTypeObject type, const char *error_prefix)
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)
PyObject *	PyC_Tuple_PackArray_String (const char **array, uint len)
PyObject *	PyC_Tuple_PackArray_Multi_F32 (const float *array, const int dims[], int dims_len)
PyObject *	PyC_Tuple_PackArray_Multi_F64 (const double *array, const int dims[], int dims_len)
PyObject *	PyC_Tuple_PackArray_Multi_I32 (const int *array, const int dims[], int dims_len)
PyObject *	PyC_Tuple_PackArray_Multi_Bool (const bool *array, const int dims[], int dims_len)
void	PyC_Tuple_Fill (PyObject tuple, PyObject value)
void	PyC_List_Fill (PyObject list, PyObject value)
PyObject *	PyC_UnicodeFromBytes (const char *str)
PyObject *	PyC_UnicodeFromBytesAndSize (const char *str, Py_ssize_t size)
const char *	PyC_UnicodeAsBytes (PyObject py_str, PyObject *r_coerce)
const char *	PyC_UnicodeAsBytesAndSize (PyObject py_str, Py_ssize_t r_size, PyObject **r_coerce)
int	PyC_ParseUnicodeAsBytesAndSize (PyObject o, void p)
int	PyC_ParseUnicodeAsBytesAndSize_OrNone (PyObject o, void p)
PyObject *	PyC_DefaultNameSpace (const char *filename) ATTR_NONNULL(1)
void	PyC_RunQuicky (const char *filepath, int n,...) ATTR_NONNULL(1)
bool	PyC_NameSpace_ImportArray (PyObject py_dict, const char imports[])
PyObject *	PyC_MainModule_Backup ()
void	PyC_MainModule_Restore (PyObject *main_mod)
bool	PyC_IsInterpreterActive ()
void *	PyC_RNA_AsPointer (PyObject value, const char type_name)
PyObject *	PyC_FlagSet_AsString (const PyC_FlagSet *item)
int	PyC_FlagSet_ValueFromID_int (const PyC_FlagSet item, const char identifier, int *r_value)
int	PyC_FlagSet_ValueFromID (const PyC_FlagSet item, const char identifier, int r_value, const char error_prefix)
int	PyC_FlagSet_ToBitfield (const PyC_FlagSet items, PyObject value, int r_value, const char error_prefix)
PyObject *	PyC_FlagSet_FromBitfield (PyC_FlagSet *items, int flag)
bool	PyC_RunString_AsNumber (const char *imports, const char expr, const char filename, double r_value) ATTR_NONNULL(2
bool bool	PyC_RunString_AsIntPtr (const char *imports, const char expr, const char filename, intptr_t r_value) ATTR_NONNULL(2
bool bool bool	PyC_RunString_AsStringAndSize (const char *imports, const char expr, const char filename, char r_value, size_t r_value_size) ATTR_NONNULL(2
bool bool bool bool	PyC_RunString_AsString (const char *imports, const char expr, const char filename, char *r_value) ATTR_NONNULL(2
bool bool bool bool bool	PyC_RunString_AsStringAndSizeOrNone (const char *imports, const char expr, const char filename, char r_value, size_t r_value_size) ATTR_NONNULL(2
bool bool bool bool bool bool	PyC_RunString_AsStringOrNone (const char *imports, const char expr, const char filename, char *r_value) ATTR_NONNULL(2
bool bool bool bool bool bool void	PyC_StdFilesFlush ()
int	PyC_ParseBool (PyObject o, void p)
int	PyC_ParseStringEnum (PyObject o, void p)
const char *	PyC_StringEnum_FindIDFromValue (const struct PyC_StringEnumItems *items, int value)
int	PyC_CheckArgs_DeepCopy (PyObject *args)
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)
uint64_t	PyC_Long_AsU64 (PyObject *value)
	Py_LOCAL_INLINE (int32_t) PyC_Long_AsI32(PyObject *value)
	Py_LOCAL_INLINE (int64_t) PyC_Long_AsI64(PyObject *value)
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)
PyObject *	PyC_UnicodeFromStdStr (const std::string &str)
PyObject *	PyC_Tuple_Pack_F32 (const blender::Span< float > values)
PyObject *	PyC_Tuple_Pack_F64 (const blender::Span< double > values)
PyObject *	PyC_Tuple_Pack_I32 (const blender::Span< int > values)
PyObject *	PyC_Tuple_Pack_I32FromBool (const blender::Span< int > values)
PyObject *	PyC_Tuple_Pack_Bool (const blender::Span< bool > values)

Function Documentation

◆ Py_LOCAL_INLINE() [1/2]

Py_LOCAL_INLINE ( int32_t )

nodiscard

Definition at line 358 of file py_capi_utils.hh.

References PyLong_AsInt, and PyC_StringEnumItems::value.

◆ Py_LOCAL_INLINE() [2/2]

Py_LOCAL_INLINE ( int64_t )

nodiscard

Definition at line 366 of file py_capi_utils.hh.

References PyC_StringEnumItems::value.

◆ PyC_AsArray()

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

nodiscard

Definition at line 176 of file py_capi_utils.cc.

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

Referenced by bpy_gizmo_target_set_value(), BPy_IDArray_ass_slice(), bpy_prop_array_from_py_with_dims(), idprop_ui_data_update_bool_default(), idprop_ui_data_update_float_default(), idprop_ui_data_update_int_default(), 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,
		size_t	array_item_size,
		PyObject *	value_fast,
		Py_ssize_t	length,
		const PyTypeObject *	type,
		const char *	error_prefix )

nodiscard

Definition at line 43 of file py_capi_utils.cc.

References BLI_assert, BLI_assert_unreachable, float, i, length(), PyC_Long_AsI16(), and PyC_Long_AsI8().

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

◆ PyC_AsArray_Multi()

int PyC_AsArray_Multi	(	void *	array,
		size_t	array_item_size,
		PyObject *	value,
		const int *	dims,
		int	dims_len,
		const PyTypeObject *	type,
		const char *	error_prefix )

nodiscard

Definition at line 284 of file py_capi_utils.cc.

References PyC_AsArray_Multi_impl().

Referenced by bpy_prop_array_from_py_with_dims().

◆ PyC_AsArray_Multi_FAST()

int PyC_AsArray_Multi_FAST	(	void *	array,
		size_t	array_item_size,
		PyObject *	value_fast,
		const int *	dims,
		int	dims_len,
		const PyTypeObject *	type,
		const char *	error_prefix )

nodiscard

Definition at line 272 of file py_capi_utils.cc.

References PyC_AsArray_Multi_FAST_impl().

◆ PyC_CheckArgs_DeepCopy()

int PyC_CheckArgs_DeepCopy ( PyObject * args )

nodiscard

Silly function, we don't use arg. just check its compatible with __deepcopy__.

Definition at line 554 of file py_capi_utils.cc.

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

◆ PyC_DefaultNameSpace()

PyObject * PyC_DefaultNameSpace ( const char * filename )

nodiscard

Description: This function creates a new Python dictionary object. NOTE: dict is owned by sys.modules["__main__"] module, reference is borrowed NOTE: important we use the dict from main, this is what python expects for 'pickle' to work as well as strings like this...

foo = 10 print(import("__main__").foo)

NOTE: this overwrites main which gives problems with nested calls. be sure to run PyC_MainModule_Backup & PyC_MainModule_Restore if there is any chance that python is in the call stack.

Definition at line 1111 of file py_capi_utils.cc.

References Py_DECREF(), and PyC_UnicodeFromBytes().

Referenced by bpy_rna_uilayout_introspect(), bpy_run_string_impl(), pyc_run_string_as_py_object(), PyC_RunQuicky(), 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 can't 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 780 of file py_capi_utils.cc.

References Py_DECREF().

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

◆ PyC_Err_PrintWithFunc()

void PyC_Err_PrintWithFunc ( PyObject * py_func )

Use for Python callbacks run directly from C, when we can't use normal methods of raising exceptions.

Definition at line 831 of file py_capi_utils.cc.

Referenced by bpy_msgbus_notify(), bpy_prop_boolean_array_from_callback_or_error(), bpy_prop_boolean_array_set_fn(), bpy_prop_boolean_get_fn(), bpy_prop_boolean_get_transform_fn(), bpy_prop_boolean_set_fn(), bpy_prop_boolean_set_transform_fn(), bpy_prop_enum_get_fn(), bpy_prop_enum_get_transform_fn(), bpy_prop_enum_itemf_fn(), bpy_prop_enum_set_fn(), bpy_prop_enum_set_transform_fn(), bpy_prop_float_array_from_callback_or_error(), bpy_prop_float_array_set_fn(), bpy_prop_float_get_fn(), bpy_prop_float_get_transform_fn(), bpy_prop_float_set_fn(), bpy_prop_float_set_transform_fn(), bpy_prop_int_array_from_callback_or_error(), bpy_prop_int_array_set_fn(), bpy_prop_int_get_fn(), bpy_prop_int_get_transform_fn(), bpy_prop_int_set_fn(), bpy_prop_int_set_transform_fn(), bpy_prop_pointer_poll_fn(), bpy_prop_string_from_callback_or_error(), bpy_prop_string_set_fn(), bpy_prop_string_visit_fn_call(), bpy_prop_string_visit_for_search_fn(), and bpy_prop_update_fn().

◆ PyC_Err_SetString_Prefix()

PyObject * PyC_Err_SetString_Prefix	(	PyObject *	exception_type_prefix,
		const char *	str )

Definition at line 826 of file py_capi_utils.cc.

References PyC_Err_Format_Prefix(), and str.

Referenced by bpy_app_debug_value_set().

◆ PyC_ExceptionBuffer()

PyObject * PyC_ExceptionBuffer ( )

nodiscard

Return a string containing the full stack trace.

Only call when PyErr_Occurred() != 0 .
The exception is left in place without being manipulated, although they will be normalized in order to display them (PyErr_Print also does this).
SystemExit exceptions will exit (so sys.exit(..) works, matching PyErr_Print behavior).
The always returns a Python string (unless exiting where the function doesn't return).

Definition at line 895 of file py_capi_utils.cc.

References BLI_assert, Py_DECREF(), pyc_exception_buffer_handle_system_exit(), result, and UNLIKELY.

Referenced by BPy_errors_to_report_ex(), pointer_type_from_py(), pyrna_py_to_prop(), and run_string_handle_error().

◆ PyC_ExceptionBuffer_Simple()

PyObject * PyC_ExceptionBuffer_Simple ( )

nodiscard

A version of PyC_ExceptionBuffer that returns the last exception only.

Useful for error messages from evaluating numeric expressions for example where a full multi-line stack-trace isn't needed and doesn't format well in the status-bar.

Definition at line 955 of file py_capi_utils.cc.

References BLI_assert, pyc_exception_buffer_handle_system_exit(), result, and UNLIKELY.

Referenced by BPy_errors_to_report_ex(), and run_string_handle_error().

◆ PyC_FileAndNum()

void PyC_FileAndNum	(	const char **	r_filename,
		int *	r_lineno )

Definition at line 654 of file py_capi_utils.cc.

References mod, and Py_DECREF().

Referenced by BPy_errors_to_report_ex(), PyC_FileAndNum_Safe(), PyC_LineSpit(), and pyrna_func_vectorcall().

◆ PyC_FileAndNum_Safe()

void PyC_FileAndNum_Safe	(	const char **	r_filename,
		int *	r_lineno )

Definition at line 708 of file py_capi_utils.cc.

References PyC_FileAndNum(), and PyC_IsInterpreterActive().

Referenced by BPY_python_current_file_and_line().

◆ PyC_FlagSet_AsString()

PyObject * PyC_FlagSet_AsString ( const PyC_FlagSet * item )

nodiscard

Definition at line 1374 of file py_capi_utils.cc.

References PyC_FlagSet::identifier, and Py_DECREF().

Referenced by PyC_FlagSet_ValueFromID().

◆ PyC_FlagSet_FromBitfield()

PyObject * PyC_FlagSet_FromBitfield	(	PyC_FlagSet *	items,
		int	flag )

nodiscard

Definition at line 1463 of file py_capi_utils.cc.

References flag, PyC_FlagSet::identifier, Py_DECREF(), ret, and PyC_FlagSet::value.

Referenced by bpy_bmesh_select_mode_get().

◆ PyC_FlagSet_ToBitfield()

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

nodiscard

Definition at line 1413 of file py_capi_utils.cc.

References flag, Py_DECREF(), PyC_FlagSet_ValueFromID(), and ret.

Referenced by bpy_bmesh_select_mode_set(), bpy_bmesh_transform(), bpy_slot_from_py(), and pygpu_shader_info_image().

◆ PyC_FlagSet_ValueFromID()

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

nodiscard

Definition at line 1397 of file py_capi_utils.cc.

References Py_DECREF(), PyC_FlagSet_AsString(), and PyC_FlagSet_ValueFromID_int().

Referenced by bpy_slot_from_py(), M_Noise_fractal(), M_Noise_hetero_terrain(), M_Noise_hybrid_multi_fractal(), M_Noise_multi_fractal(), M_Noise_noise(), M_Noise_noise_vector(), M_Noise_ridged_multi_fractal(), M_Noise_turbulence(), M_Noise_turbulence_vector(), M_Noise_variable_lacunarity(), M_Noise_voronoi(), and PyC_FlagSet_ToBitfield().

◆ PyC_FlagSet_ValueFromID_int()

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

nodiscard

Definition at line 1385 of file py_capi_utils.cc.

References PyC_FlagSet::identifier, STREQ, and PyC_FlagSet::value.

Referenced by PyC_FlagSet_ValueFromID().

◆ PyC_FrozenSetFromStrings()

PyObject * PyC_FrozenSetFromStrings ( const char ** strings )

nodiscard

Definition at line 758 of file py_capi_utils.cc.

References Py_DECREF(), ret, and str.

Referenced by BPyInit__bpy_path().

◆ PyC_IsInterpreterActive()

bool PyC_IsInterpreterActive ( )

nodiscard

Definition at line 1173 of file py_capi_utils.cc.

Referenced by BPY_context_dict_clear_members_array(), BPY_context_member_get(), BPY_python_current_file_and_line(), BPY_text_free_code(), PyC_FileAndNum_Safe(), PyC_LineSpit(), and PyC_StackSpit().

◆ PyC_LineSpit()

void PyC_LineSpit ( )

Definition at line 616 of file py_capi_utils.cc.

References PyC_FileAndNum(), and PyC_IsInterpreterActive().

Referenced by _RNA_warning().

◆ PyC_List_Fill()

void PyC_List_Fill	(	PyObject *	list,
		PyObject *	value )

Definition at line 486 of file py_capi_utils.cc.

References i.

◆ PyC_Long_AsBool()

int PyC_Long_AsBool ( PyObject * value )

nodiscard

Comparison with #PyObject_IsTrue

Even though Python provides a way to retrieve the boolean value for an object, in many cases it's far too relaxed, with the following examples coercing values.

data.value = "Text"    # True.
data.value = ""        # False.
data.value = {1, 2}    # True
data.value = {}        # False.
data.value = None      # False.

In practice this is often a mistake by the script author that doesn't behave as they expect. So it's better to be more strict for attribute assignment and function arguments, only accepting True/False 0/1.

If coercing a value is desired, it can be done explicitly: data.value = bool(value)

See also: PyC_ParseBool for use with #PyArg_ParseTuple and related functions.

Note: Don't use bool return type, so -1 can be used as an error value.

Definition at line 1764 of file py_capi_utils.cc.

References PyLong_AsInt, and UNLIKELY.

Referenced by bpy_bm_elem_hflag_set(), bpy_bm_elem_hide_set(), bpy_bm_elem_select_set(), bpy_bmesh_select_flush(), bpy_bmesh_uv_select_flush(), bpy_bmesh_uv_select_flush_shared(), bpy_bmesh_uv_select_sync_valid_set(), bpy_bmface_uv_select_set(), BPy_BMLayerItem_SetItem(), bpy_bmloop_uv_select_edge_set(), bpy_bmloop_uv_select_vert_set(), bpy_bmloopuv_pin_uv_set(), bpy_bmvertskin_flag_set(), BPy_IDArray_SetItem(), bpy_prop_boolean_get_fn(), bpy_prop_boolean_get_transform_fn(), bpy_prop_boolean_set_transform_fn(), bpy_slot_from_py(), foreach_getset(), idp_from_PyBool(), idp_from_PySequence_Fast(), idprop_ui_data_update_bool_default(), pyrna_array_contains_py(), and pyrna_py_to_prop_array_index().

◆ PyC_Long_AsI16()

int16_t PyC_Long_AsI16 ( PyObject * value )

nodiscard

Definition at line 1790 of file py_capi_utils.cc.

References INT16_MAX, PyLong_AsInt, and UNLIKELY.

Referenced by bpy_app_debug_value_set(), foreach_getset(), and PyC_AsArray_FAST().

◆ PyC_Long_AsI8()

int8_t PyC_Long_AsI8 ( PyObject * value )

nodiscard

Definition at line 1777 of file py_capi_utils.cc.

References INT8_MAX, PyLong_AsInt, and UNLIKELY.

Referenced by foreach_getset(), and PyC_AsArray_FAST().

◆ PyC_Long_AsU16()

uint16_t PyC_Long_AsU16 ( PyObject * value )

nodiscard

Definition at line 1821 of file py_capi_utils.cc.

References pyc_Long_AsUnsignedLong(), UINT16_MAX, and UNLIKELY.

Referenced by foreach_getset().

◆ PyC_Long_AsU32()

uint32_t PyC_Long_AsU32 ( PyObject * value )

nodiscard

Definition at line 1834 of file py_capi_utils.cc.

References pyc_Long_AsUnsignedLong(), UINT32_MAX, and UNLIKELY.

Referenced by C_BVHTree_FromPolygons(), pygpu_framebuffer_clear(), pygpu_IndexBuf__tp_new(), and pygpu_select_load_id().

◆ PyC_Long_AsU64()

uint64_t PyC_Long_AsU64 ( PyObject * value )

nodiscard

#PyLong_AsUnsignedLongLong, unlike #PyLong_AsLongLong, does not fall back to calling #PyNumber_Index when its argument is not a PyLongObject instance. To match parsing signed integer types with #PyLong_AsLongLong, this function performs the #PyNumber_Index fallback, if necessary, before calling #PyLong_AsUnsignedLongLong.

Definition at line 1847 of file py_capi_utils.cc.

References Py_DECREF().

Referenced by foreach_getset().

◆ PyC_Long_AsU8()

uint8_t PyC_Long_AsU8 ( PyObject * value )

nodiscard

Unlike Python's #PyLong_AsUnsignedLong and #PyLong_AsUnsignedLongLong, these unsigned integer parsing functions fall back to calling #PyNumber_Index when their argument is not a PyLongObject. This matches Python's signed integer parsing functions which also fall back to calling #PyNumber_Index.

Definition at line 1808 of file py_capi_utils.cc.

References pyc_Long_AsUnsignedLong(), UINT8_MAX, and UNLIKELY.

Referenced by foreach_getset().

◆ PyC_MainModule_Backup()

PyObject * PyC_MainModule_Backup ( )

nodiscard

PyC_MainModule_Restore MUST be called after PyC_MainModule_Backup.

Definition at line 1149 of file py_capi_utils.cc.

Referenced by bpy_rna_uilayout_introspect(), bpy_run_string_impl(), pyc_run_string_as_py_object(), and python_script_exec().

◆ PyC_MainModule_Restore()

void PyC_MainModule_Restore ( PyObject * main_mod )

Definition at line 1161 of file py_capi_utils.cc.

References Py_DECREF().

Referenced by bpy_rna_uilayout_introspect(), bpy_run_string_impl(), pyc_run_string_as_py_object(), and python_script_exec().

◆ PyC_NameSpace_ImportArray()

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

nodiscard

Import imports into py_dict.

Parameters

py_dict	A Python dictionary, typically used as a name-space for script execution.
imports	A NULL terminated array of strings.

Returns: true when all modules import without errors, otherwise return false. The caller is expected to handle the exception.

Definition at line 1129 of file py_capi_utils.cc.

References i, mod, name, and Py_DECREF().

Referenced by bpy_run_string_impl(), and pyc_run_string_as_py_object().

◆ PyC_Object_GetAttrStringArgs()

PyObject * PyC_Object_GetAttrStringArgs	(	PyObject *	o,
		Py_ssize_t	n,
			... )

nodiscard

Definition at line 723 of file py_capi_utils.cc.

References i, and Py_DECREF().

◆ PyC_ObSpit()

void PyC_ObSpit	(	const char *	name,
		PyObject *	var )

Useful to print Python objects while debugging.

Definition at line 570 of file py_capi_utils.cc.

References name.

Referenced by bpy_class_free_ex(), PyC_RunQuicky(), and pyrna_subtype_set_rna().

◆ PyC_ObSpitStr()

void PyC_ObSpitStr	(	char *	result,
		size_t	result_maxncpy,
		PyObject *	var )

A version of PyC_ObSpit that writes into a string (and doesn't take a name argument). Use for logging.

Definition at line 588 of file py_capi_utils.cc.

References BLI_snprintf_utf8(), BLI_strncpy_utf8(), Py_DECREF(), and result.

Referenced by pyrna_srna_ExternalType().

◆ PyC_ParseBool()

int PyC_ParseBool	(	PyObject *	o,
		void *	p )

nodiscard

Use with PyArg_ParseTuple's "O&" formatting.

See also: PyC_Long_AsBool for a similar function to use outside of argument parsing.

Definition at line 503 of file py_capi_utils.cc.

References ELEM, and true.

Referenced by bpy_app_help_text(), bpy_blend_paths(), bpy_bm_new(), bpy_bm_update_edit_mesh(), bpy_bm_utils_edge_rotate(), bpy_bm_utils_face_join(), bpy_bm_utils_face_split(), bpy_bm_utils_uv_select_check(), bpy_bmelemseq_sort(), bpy_bmesh_from_mesh(), bpy_bmesh_from_object(), bpy_bmesh_select_flush_mode(), bpy_bmesh_uv_select_flush_mode(), bpy_bmesh_uv_select_foreach_set(), bpy_bmesh_uv_select_foreach_set_from_mesh(), bpy_bmface_copy(), bpy_bmface_copy_from_face_interp(), bpy_bmloop_copy_from_face_interp(), BPy_BoolProperty(), bpy_driver_secure_code_test(), bpy_flip_name(), bpy_lib_load(), bpy_lib_write(), bpy_orphans_purge(), bpy_rna_context_temp_override_logging_set(), bpyunits_to_string(), C_BVHTree_FromObject(), C_BVHTree_FromPolygons(), M_Geometry_intersect_line_plane(), M_Geometry_intersect_line_sphere(), M_Geometry_intersect_line_sphere_2d(), M_Geometry_intersect_ray_tri(), py_find_nearest_cb(), pygpu_offscreen_draw_view3d(), pygpu_offscreen_unbind(), pygpu_state_depth_mask_set(), pygpu_state_front_facing_set(), pygpu_state_program_point_size_set(), pygpu_state_scissor_test_set(), pyop_as_string(), and pyrna_struct_is_property_set().

◆ PyC_ParseStringEnum()

int PyC_ParseStringEnum	(	PyObject *	o,
		void *	p )

nodiscard

Use with PyArg_ParseTuple's "O&" formatting.

Definition at line 516 of file py_capi_utils.cc.

References e, i, Py_DECREF(), and STREQ.

Referenced by bpy_bmesh_uv_select_foreach_set(), bpy_bmesh_uv_select_foreach_set_from_mesh(), bpy_bmesh_uv_select_sync_from_mesh(), bpy_lib_write(), bpy_resource_path(), bpy_system_resource(), bpy_user_resource(), bpy_utils_previews_load(), py_imbuf_resize(), pygpu_batch__tp_new(), pygpu_buffer__tp_new(), pygpu_framebuffer_read_color(), pygpu_IndexBuf__tp_new(), pygpu_interface_info_get_args(), pygpu_offscreen__tp_new(), pygpu_shader_from_builtin(), pygpu_shader_info_depth_write(), pygpu_shader_info_fragment_out(), pygpu_shader_info_image(), pygpu_shader_info_push_constant(), pygpu_shader_info_sampler(), pygpu_shader_info_vertex_in(), pygpu_state_blend_set(), pygpu_state_depth_test_set(), pygpu_state_face_culling_set(), pygpu_texture__tp_new(), pygpu_texture_clear(), and pygpu_vertformat_attr_add().

◆ PyC_ParseUnicodeAsBytesAndSize()

int PyC_ParseUnicodeAsBytesAndSize	(	PyObject *	o,
		void *	p )

Use with PyArg_ParseTuple's "O&" formatting.

Expose PyC_UnicodeAsBytes in a way which is useful to the argument parser.

Parameters

o	An argument parsed to PyC_UnicodeAsBytes.
p	Pointer to #PyC_UnicodeAsBytes_Data.

Note: The Python API docs reference PyUnicode_FSConverter however this does not support paths which non UTF8 encoding, see: #111033.

Definition at line 1075 of file py_capi_utils.cc.

References BLI_assert, data, PyC_UnicodeAsBytesAndSize(), and UNLIKELY.

Referenced by bpy_app_icons_new_triangles_from_file(), bpy_lib_load(), bpy_lib_write(), bpy_system_resource(), bpy_user_resource(), bpy_utils_previews_load(), M_imbuf_load(), py_blf_load(), py_blf_unload(), and PyC_ParseUnicodeAsBytesAndSize_OrNone().

◆ PyC_ParseUnicodeAsBytesAndSize_OrNone()

int PyC_ParseUnicodeAsBytesAndSize_OrNone	(	PyObject *	o,
		void *	p )

A version of PyC_ParseUnicodeAsBytesAndSize that accepts None.

Definition at line 1094 of file py_capi_utils.cc.

References BLI_assert, data, PyC_ParseUnicodeAsBytesAndSize(), and UNUSED_VARS_NDEBUG.

Referenced by bpy_rna_data_temp_data(), and M_imbuf_write().

◆ PyC_RNA_AsPointer()

void * PyC_RNA_AsPointer	(	PyObject *	value,
		const char *	type_name )

nodiscard

Generic function to avoid depending on RNA.

Definition at line 1331 of file py_capi_utils.cc.

References Py_DECREF(), result, and STREQ.

Referenced by BlenderTextureShader___init__(), bpy_bm_from_edit_mesh(), bpy_bm_update_edit_mesh(), bpy_bmesh_from_mesh(), bpy_bmesh_from_object(), bpy_bmesh_to_mesh(), C_BVHTree_FromObject(), pygpu_offscreen_draw_view3d(), and pygpu_texture_from_image().

◆ PyC_RunQuicky()

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

Definition at line 1185 of file py_capi_utils.cc.

References i, printf, ptr, Py_DECREF(), PyC_DefaultNameSpace(), PyC_ObSpit(), and ret.

◆ PyC_RunString_AsIntPtr()

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

nodiscard

◆ PyC_RunString_AsNumber()

bool PyC_RunString_AsNumber	(	const char **	imports,
		const char *	expr,
		const char *	filename,
		double *	r_value )

nodiscard

Returns: success

Note: it is caller's responsibility to acquire & release GIL!

◆ PyC_RunString_AsString()

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

nodiscard

◆ PyC_RunString_AsStringAndSize()

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

nodiscard

Parameters

r_value_size The length of the string assigned: strlen(*r_value).

◆ PyC_RunString_AsStringAndSizeOrNone()

bool bool bool bool bool PyC_RunString_AsStringAndSizeOrNone	(	const char **	imports,
		const char *	expr,
		const char *	filename,
		char **	r_value,
		size_t *	r_value_size )

nodiscard

Parameters

r_value_size The length of the string assigned: strlen(*r_value).

◆ PyC_RunString_AsStringOrNone()

bool bool bool bool bool bool PyC_RunString_AsStringOrNone	(	const char **	imports,
		const char *	expr,
		const char *	filename,
		char **	r_value )

nodiscard

◆ PyC_StackSpit()

void PyC_StackSpit ( )

Definition at line 634 of file py_capi_utils.cc.

References PyC_IsInterpreterActive().

◆ PyC_StdFilesFlush()

bool bool bool bool bool bool void PyC_StdFilesFlush ( )

Flush Python's sys.stdout and sys.stderr. Errors are ignored.

Definition at line 1689 of file py_capi_utils.cc.

References BLI_assert, name, and Py_DECREF().

Referenced by python_script_exec().

◆ PyC_StringEnum_FindIDFromValue()

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

nodiscard

◆ PyC_StructFmt_type_from_str()

char PyC_StructFmt_type_from_str ( const char * typestr )

nodiscard

Definition at line 1880 of file py_capi_utils.cc.

Referenced by idp_array_type_from_formatstr_and_size(), and pygpu_IndexBuf__tp_new().

◆ PyC_StructFmt_type_is_bool()

bool PyC_StructFmt_type_is_bool ( char format )

nodiscard

Definition at line 1940 of file py_capi_utils.cc.

◆ PyC_StructFmt_type_is_byte()

bool PyC_StructFmt_type_is_byte ( char format )

nodiscard

Definition at line 1928 of file py_capi_utils.cc.

◆ PyC_StructFmt_type_is_float_any()

bool PyC_StructFmt_type_is_float_any ( char format )

nodiscard

Definition at line 1894 of file py_capi_utils.cc.

Referenced by idp_array_type_from_formatstr_and_size(), and pygpu_IndexBuf__tp_new().

◆ PyC_StructFmt_type_is_int_any()

bool PyC_StructFmt_type_is_int_any ( char format )

nodiscard

Definition at line 1906 of file py_capi_utils.cc.

Referenced by idp_array_type_from_formatstr_and_size().

◆ PyC_Tuple_Fill()

void PyC_Tuple_Fill	(	PyObject *	tuple,
		PyObject *	value )

Caller needs to ensure tuple is uninitialized. Handy for filling a tuple with None for eg.

Definition at line 475 of file py_capi_utils.cc.

References i.

Referenced by kdtree_nearest_to_py_and_check(), py_bvhtree_nearest_to_py_none(), and py_bvhtree_raycast_to_py_none().

◆ PyC_Tuple_Pack_Bool()

PyObject * PyC_Tuple_Pack_Bool ( const blender::Span< bool > values )

inlinenodiscard

Definition at line 399 of file py_capi_utils.hh.

References blender::Span< T >::data(), PyC_Tuple_PackArray_Bool(), and blender::Span< T >::size().

◆ PyC_Tuple_Pack_F32()

PyObject * PyC_Tuple_Pack_F32 ( const blender::Span< float > values )

inlinenodiscard

Definition at line 383 of file py_capi_utils.hh.

References blender::Span< T >::data(), PyC_Tuple_PackArray_F32(), and blender::Span< T >::size().

◆ PyC_Tuple_Pack_F64()

PyObject * PyC_Tuple_Pack_F64 ( const blender::Span< double > values )

inlinenodiscard

Definition at line 387 of file py_capi_utils.hh.

References blender::Span< T >::data(), PyC_Tuple_PackArray_F64(), and blender::Span< T >::size().

Referenced by py_imbuf_ppm_get().

◆ PyC_Tuple_Pack_I32()

PyObject * PyC_Tuple_Pack_I32 ( const blender::Span< int > values )

inlinenodiscard

Definition at line 391 of file py_capi_utils.hh.

References blender::Span< T >::data(), PyC_Tuple_PackArray_I32(), and blender::Span< T >::size().

Referenced by M_Geometry_tessellate_polygon(), make_alembic_info(), make_app_info(), make_ocio_info(), make_oiio_info(), make_opensubdiv_info(), make_openvdb_info(), make_sdl_info(), make_usd_info(), and py_imbuf_size_get().

◆ PyC_Tuple_Pack_I32FromBool()

PyObject * PyC_Tuple_Pack_I32FromBool ( const blender::Span< int > values )

inlinenodiscard

Definition at line 395 of file py_capi_utils.hh.

References blender::Span< T >::data(), PyC_Tuple_PackArray_I32FromBool(), and blender::Span< T >::size().

◆ PyC_Tuple_PackArray_Bool()

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

nodiscard

Definition at line 341 of file py_capi_utils.cc.

References i, and len.

Referenced by bpy_py_object_from_prop_array_with_dims(), PyC_Tuple_Pack_Bool(), and PyC_Tuple_PackArray_Multi_Bool_impl().

◆ PyC_Tuple_PackArray_F32()

PyObject * PyC_Tuple_PackArray_F32	(	const float *	array,
		uint	len )

nodiscard

Definition at line 305 of file py_capi_utils.cc.

References i, and len.

Referenced by bpy_gizmo_target_get_range(), bpy_gizmo_target_get_value(), bpy_py_object_from_prop_array_with_dims(), py_rna_gizmo_handler_set_cb(), PyC_Tuple_Pack_F32(), and PyC_Tuple_PackArray_Multi_F32_impl().

◆ PyC_Tuple_PackArray_F64()

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

nodiscard

Definition at line 314 of file py_capi_utils.cc.

References i, and len.

Referenced by PyC_Tuple_Pack_F64(), and PyC_Tuple_PackArray_Multi_F64_impl().

◆ PyC_Tuple_PackArray_I32()

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

nodiscard

Definition at line 323 of file py_capi_utils.cc.

References i, and len.

Referenced by bpy_lib_enter(), bpy_py_object_from_prop_array_with_dims(), PyC_Tuple_Pack_I32(), and PyC_Tuple_PackArray_Multi_I32_impl().

◆ PyC_Tuple_PackArray_I32FromBool()

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

nodiscard

Definition at line 332 of file py_capi_utils.cc.

References i, and len.

Referenced by PyC_Tuple_Pack_I32FromBool().

◆ PyC_Tuple_PackArray_Multi_Bool()

PyObject * PyC_Tuple_PackArray_Multi_Bool	(	const bool *	array,
		const int	dims[],
		int	dims_len )

nodiscard

Definition at line 464 of file py_capi_utils.cc.

References PyC_Tuple_PackArray_Multi_Bool_impl().

Referenced by bpy_py_object_from_prop_array_with_dims().

◆ PyC_Tuple_PackArray_Multi_F32()

PyObject * PyC_Tuple_PackArray_Multi_F32	(	const float *	array,
		const int	dims[],
		int	dims_len )

nodiscard

Definition at line 392 of file py_capi_utils.cc.

References PyC_Tuple_PackArray_Multi_F32_impl().

Referenced by bpy_py_object_from_prop_array_with_dims().

◆ PyC_Tuple_PackArray_Multi_F64()

PyObject * PyC_Tuple_PackArray_Multi_F64	(	const double *	array,
		const int	dims[],
		int	dims_len )

nodiscard

Definition at line 416 of file py_capi_utils.cc.

References PyC_Tuple_PackArray_Multi_F64_impl().

◆ PyC_Tuple_PackArray_Multi_I32()

PyObject * PyC_Tuple_PackArray_Multi_I32	(	const int *	array,
		const int	dims[],
		int	dims_len )

nodiscard

Definition at line 440 of file py_capi_utils.cc.

References PyC_Tuple_PackArray_Multi_I32_impl().

Referenced by bpy_py_object_from_prop_array_with_dims().

◆ PyC_Tuple_PackArray_String()

PyObject * PyC_Tuple_PackArray_String	(	const char **	array,
		uint	len )

nodiscard

Note: Any errors converting strings will return null with the error left as-is.

Definition at line 350 of file py_capi_utils.cc.

References i, len, and Py_DECREF().

Referenced by bpy_app_python_args_get().

◆ PyC_UnicodeAsBytes()

const char * PyC_UnicodeAsBytes	(	PyObject *	py_str,
		PyObject **	r_coerce )

nodiscard

Definition at line 1025 of file py_capi_utils.cc.

References result.

Referenced by bpy_app_binary_path_set(), pyrna_py_to_prop(), and pyrna_WindowManager_clipboard_set().

◆ PyC_UnicodeAsBytesAndSize()

const char * PyC_UnicodeAsBytesAndSize	(	PyObject *	py_str,
		Py_ssize_t *	r_size,
		PyObject **	r_coerce )

nodiscard

String conversion, escape non-unicode chars

Parameters

r_size The string length (not including the null terminator).

Note: By convention Blender API's use len/length however Python API's use the term size, as this is an alternative to Python's #PyUnicode_AsUTF8AndSize, follow it's naming.

Parameters

r_coerce must reference a pointer set to NULL.

Definition at line 998 of file py_capi_utils.cc.

References result.

Referenced by foreach_id_file_path_foreach_callback(), idp_from_PyUnicode(), py_imbuf_filepath_set(), and PyC_ParseUnicodeAsBytesAndSize().

◆ PyC_UnicodeFromBytes()

PyObject * PyC_UnicodeFromBytes ( const char * str )

nodiscard

Create a str from bytes in a way which is compatible with non UTF8 encoded file-system paths, see: #111033. Follow http://www.python.org/dev/peps/pep-0383/

Definition at line 1065 of file py_capi_utils.cc.

References PyC_UnicodeFromBytesAndSize(), and str.

Referenced by bpy_app_autoexec_fail_message_get(), bpy_app_binary_path_get(), bpy_app_tempdir_get(), bpy_blend_foreach_path_cb(), foreach_id_file_path_map(), foreach_id_file_path_map_callback(), Freestyle_Init(), py_imbuf_filepath_get(), PyC_DefaultNameSpace(), pyrna_struct_CreatePyObject_with_primitive_support(), python_compat_wrapper_PyRun_FileExFlags(), and python_script_exec().

◆ PyC_UnicodeFromBytesAndSize()

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

nodiscard

Parameters

size	The length of the string: strlen(str).

Definition at line 1050 of file py_capi_utils.cc.

References result, size(), and str.

Referenced by idprop_py_from_idp_string(), PyC_UnicodeFromBytes(), PyC_UnicodeFromStdStr(), pyrna_param_to_py(), pyrna_prop_to_py(), pyrna_struct_get_nameprop_as_pyobject(), and pyrna_WindowManager_clipboard_get().

◆ PyC_UnicodeFromStdStr()

PyObject * PyC_UnicodeFromStdStr ( const std::string & str )

nodiscard

Create a str from std::string, wraps PyC_UnicodeFromBytesAndSize.

Definition at line 1070 of file py_capi_utils.cc.

References PyC_UnicodeFromBytesAndSize(), and str.

Referenced by BPy_GeometrySet_get_name(), BPy_GeometrySet_repr(), BPy_init_modules(), bpy_resource_path(), bpy_script_paths(), bpy_system_resource(), bpy_user_resource(), blender::render::hydra::cache_or_get_image_file_func(), pygpu_interface_info_name_get(), pyop_as_string(), pyrna_prop_path_from_id(), pyrna_prop_path_from_module(), pyrna_struct_getattro(), pyrna_struct_path_from_id(), pyrna_struct_path_from_module(), SShape_name_get(), StrokeAttribute_repr(), ViewShape_library_path_get(), and ViewShape_name_get().

Classes

Functions

Function Documentation

◆ Py_LOCAL_INLINE() [1/2]

◆ Py_LOCAL_INLINE() [2/2]

◆ PyC_AsArray()

◆ PyC_AsArray_FAST()

◆ PyC_AsArray_Multi()

◆ PyC_AsArray_Multi_FAST()

◆ PyC_CheckArgs_DeepCopy()

◆ PyC_DefaultNameSpace()

◆ PyC_Err_Format_Prefix()

◆ PyC_Err_PrintWithFunc()

◆ PyC_Err_SetString_Prefix()

◆ PyC_ExceptionBuffer()

◆ PyC_ExceptionBuffer_Simple()

◆ PyC_FileAndNum()

◆ PyC_FileAndNum_Safe()

◆ PyC_FlagSet_AsString()

◆ PyC_FlagSet_FromBitfield()

◆ PyC_FlagSet_ToBitfield()

◆ PyC_FlagSet_ValueFromID()

◆ PyC_FlagSet_ValueFromID_int()

◆ PyC_FrozenSetFromStrings()

◆ PyC_IsInterpreterActive()

◆ PyC_LineSpit()

◆ PyC_List_Fill()

◆ PyC_Long_AsBool()

Comparison with #PyObject_IsTrue

◆ PyC_Long_AsI16()

◆ PyC_Long_AsI8()

◆ PyC_Long_AsU16()

◆ PyC_Long_AsU32()

◆ PyC_Long_AsU64()

◆ PyC_Long_AsU8()

◆ PyC_MainModule_Backup()

◆ PyC_MainModule_Restore()

◆ PyC_NameSpace_ImportArray()

◆ PyC_Object_GetAttrStringArgs()

◆ PyC_ObSpit()

◆ PyC_ObSpitStr()

◆ PyC_ParseBool()

◆ PyC_ParseStringEnum()

◆ PyC_ParseUnicodeAsBytesAndSize()

◆ PyC_ParseUnicodeAsBytesAndSize_OrNone()

◆ PyC_RNA_AsPointer()

◆ PyC_RunQuicky()

◆ PyC_RunString_AsIntPtr()

◆ PyC_RunString_AsNumber()

◆ PyC_RunString_AsString()

◆ PyC_RunString_AsStringAndSize()

◆ PyC_RunString_AsStringAndSizeOrNone()

◆ PyC_RunString_AsStringOrNone()

◆ PyC_StackSpit()

◆ PyC_StdFilesFlush()

◆ PyC_StringEnum_FindIDFromValue()

◆ PyC_StructFmt_type_from_str()

◆ PyC_StructFmt_type_is_bool()

◆ PyC_StructFmt_type_is_byte()

◆ PyC_StructFmt_type_is_float_any()

◆ PyC_StructFmt_type_is_int_any()

◆ PyC_Tuple_Fill()

◆ PyC_Tuple_Pack_Bool()

◆ PyC_Tuple_Pack_F32()

◆ PyC_Tuple_Pack_F64()

◆ PyC_Tuple_Pack_I32()

◆ PyC_Tuple_Pack_I32FromBool()

◆ PyC_Tuple_PackArray_Bool()

◆ PyC_Tuple_PackArray_F32()

◆ PyC_Tuple_PackArray_F64()

◆ PyC_Tuple_PackArray_I32()

◆ PyC_Tuple_PackArray_I32FromBool()

◆ PyC_Tuple_PackArray_Multi_Bool()

◆ PyC_Tuple_PackArray_Multi_F32()

◆ PyC_Tuple_PackArray_Multi_F64()

◆ PyC_Tuple_PackArray_Multi_I32()

◆ PyC_Tuple_PackArray_String()

◆ PyC_UnicodeAsBytes()

◆ PyC_UnicodeAsBytesAndSize()

◆ PyC_UnicodeFromBytes()