#include <optional>
#include <string>
#include "BLI_sys_types.h"

Macros
#define	BPy_BEGIN_ALLOW_THREADS
#define	BPy_END_ALLOW_THREADS

Typedefs
using	BPy_ThreadStatePtr = void *

Functions
BPy_ThreadStatePtr	BPY_thread_save ()
void	BPY_thread_restore (BPy_ThreadStatePtr tstate)
void	BPY_thread_backtrace_print ()
void	BPY_text_free_code (Text *text)
void	BPY_modules_update ()
void	BPY_modules_load_user (bContext *C)
void	BPY_app_handlers_reset (bool do_all)
void	BPY_driver_exit ()
void	BPY_driver_reset ()
float	BPY_driver_exec (PathResolvedRNA anim_rna, ChannelDriver driver, ChannelDriver driver_orig, const AnimationEvalContext anim_eval_context)
void	BPY_DECREF (void *pyob_ptr)
void	BPY_DECREF_RNA_INVALIDATE (void *pyob_ptr)
bool	BPY_context_member_get (bContext C, const char member, bContextDataResult *result)
void	BPY_context_set (bContext *C)
void	BPY_context_update (bContext *C)
void	BPY_context_dict_clear_members_array (void *dict_p, void dict_orig, const char *context_members[], uint context_members_len)
void	BPY_id_release (ID *id)
void	BPY_free_srna_pytype (StructRNA *srna)
bool	BPY_string_is_keyword (const char *str)
std::optional< std::string >	BPY_python_current_file_and_line (void)
void	BPY_callback_screen_free (ARegionType *art)
void	BPY_callback_wm_free (wmWindowManager *wm)

Macro Definition Documentation

◆ BPy_BEGIN_ALLOW_THREADS

#define BPy_BEGIN_ALLOW_THREADS

Value:

{ \
  BPy_ThreadStatePtr _bpy_saved_tstate = BPY_thread_save(); \
  (void)0

Our own wrappers to #Py_BEGIN_ALLOW_THREADS / #Py_END_ALLOW_THREADS

Definition at line 52 of file BPY_extern.hh.

Referenced by blender::deg::deg_evaluate_on_refresh(), and ED_view3d_stop_render_preview().

◆ BPy_END_ALLOW_THREADS

#define BPy_END_ALLOW_THREADS

Value:

BPY_thread_restore(_bpy_saved_tstate); \
} \
(void)0

Definition at line 56 of file BPY_extern.hh.

Referenced by blender::deg::deg_evaluate_on_refresh(), and ED_view3d_stop_render_preview().

Typedef Documentation

◆ BPy_ThreadStatePtr

using BPy_ThreadStatePtr = void *

Definition at line 40 of file BPY_extern.hh.

Function Documentation

◆ BPY_app_handlers_reset()

void BPY_app_handlers_reset ( bool do_all )

Definition at line 314 of file bpy_app_handlers.cc.

References BKE_CB_EVT_TOT, i, PERMINENT_CB_ID, pos, py_cb_array, and Py_DECREF().

Referenced by BPY_python_reset().

◆ BPY_callback_screen_free()

void BPY_callback_screen_free ( ARegionType * art )

Definition at line 482 of file bpy_rna_callback.cc.

References cb_customdata_free(), cb_region_draw(), and ED_region_draw_cb_remove_by_type().

Referenced by SpaceType::~SpaceType().

◆ BPY_callback_wm_free()

void BPY_callback_wm_free ( wmWindowManager * wm )

Definition at line 488 of file bpy_rna_callback.cc.

References cb_customdata_free(), cb_wm_cursor_draw(), and WM_paint_cursor_remove_by_type().

Referenced by wm_close_and_free().

◆ BPY_context_dict_clear_members_array()

void BPY_context_dict_clear_members_array	(	void **	dict_p,
		void *	dict_orig,
		const char *	context_members[],
		uint	context_members_len )

Use for CTX_*_set(..) functions need to set values which are later read back as expected. In this case we don't want the Python context to override the values as it causes problems see #66256.

Parameters

dict_p	A pointer to #bContext.data.py_context so we can assign a new value.
dict_orig	The value of #bContext.data.py_context_orig to check if we need to copy.

Definition at line 174 of file bpy_interface.cc.

References BLI_assert, i, Py_DECREF(), and PyC_IsInterpreterActive().

Referenced by CTX_data_scene_set(), CTX_wm_area_set(), CTX_wm_region_set(), CTX_wm_screen_set(), and CTX_wm_window_set().

◆ BPY_context_member_get()

bool BPY_context_member_get	(	bContext *	C,
		const char *	member,
		bContextDataResult *	result )

nodiscard

Definition at line 800 of file bpy_interface.cc.

References bpy_context_log_member_error(), BPy_StructRNA_Check, C, Collection, CTX_data_list_add_ptr(), CTX_data_pointer_set_ptr(), CTX_data_type_set(), CTX_py_dict_get(), i, len, Pointer, ptr, Py_DECREF(), PyC_IsInterpreterActive(), and result.

Referenced by ctx_data_get(), and ctx_wm_python_context_get().

◆ BPY_context_set()

void BPY_context_set ( bContext * C )

Definition at line 263 of file bpy_interface.cc.

References bpy_context_module, and C.

Referenced by bpy_context_clear(), and BPY_context_update().

◆ BPY_context_update()

void BPY_context_update ( bContext * C )

Use for updating while a python script runs - in case of file load.

Definition at line 102 of file bpy_interface.cc.

References BLI_thread_is_main(), BPY_context_set(), BPY_modules_update(), and C.

Referenced by bpy_context_set(), BPY_modules_load_user(), and setup_app_data().

◆ BPY_DECREF()

void BPY_DECREF ( void * pyob_ptr )

Acquire the global-interpreter-lock (GIL) and wrap Py_DECREF. as there are some cases when this needs to be called outside the Python API code.

Definition at line 714 of file bpy_interface.cc.

References Py_DECREF().

Referenced by fcurve_free_driver(), pyop_poll_message_free_fn(), and RNA_struct_free_extension().

◆ BPY_DECREF_RNA_INVALIDATE()

void BPY_DECREF_RNA_INVALIDATE ( void * pyob_ptr )

Definition at line 721 of file bpy_interface.cc.

References Py_DECREF(), and pyrna_invalidate().

Referenced by BKE_libblock_free_data_py(), RE_engine_free(), WM_gizmo_free(), wm_gizmogroup_free(), and WM_operator_free().

◆ BPY_driver_exec()

float BPY_driver_exec	(	PathResolvedRNA *	anim_rna,
		ChannelDriver *	driver,
		ChannelDriver *	driver_orig,
		const AnimationEvalContext *	anim_eval_context )

nodiscard

This evaluates Python driver expressions, driver_orig->expression is a Python expression that should evaluate to a float number, which is returned.

Definition at line 515 of file bpy_driver.cc.

References BLI_listbase_count(), BPY_driver_secure_bytecode_test_ex(), bpy_pydriver_create_dict(), bpy_pydriver_Dict, bpy_pydriver_Dict__whitelist, bpy_pydriver_namespace_clear_self(), bpy_pydriver_namespace_update_depsgraph(), bpy_pydriver_namespace_update_frame(), bpy_pydriver_namespace_update_self(), BPY_update_rna_module(), DriverVar::curval, AnimationEvalContext::depsgraph, DRIVER_FLAG_INVALID, DRIVER_FLAG_PYTHON_BLOCKED, DRIVER_FLAG_RECOMPILE, DRIVER_FLAG_RENAMEVAR, DRIVER_FLAG_USE_SELF, driver_get_variable_value(), DVAR_TYPE_SINGLE_PROP, AnimationEvalContext::eval_time, ChannelDriver::expr_comp, ChannelDriver::expression, ListBase::first, ChannelDriver::flag, float, G, G_FLAG_SCRIPT_AUTOEXEC, G_FLAG_SCRIPT_AUTOEXEC_FAIL, G_FLAG_SCRIPT_AUTOEXEC_FAIL_QUIET, i, DriverVar::name, DriverVar::next, printf, Py_DECREF(), pydriver_error(), pyrna_driver_get_variable_value(), result, SNPRINTF_UTF8, DriverVar::targets, DriverVar::type, UNLIKELY, and ChannelDriver::variables.

Referenced by evaluate_driver_python().

◆ BPY_driver_exit()

void BPY_driver_exit ( )

Run on exit to free any cached data.

Definition at line 241 of file bpy_driver.cc.

References bpy_pydriver_Dict, bpy_pydriver_Dict__whitelist, FLT_MAX, g_pydriver_state_prev, and Py_DECREF().

Referenced by BPY_driver_reset(), and BPY_python_end().

◆ BPY_driver_reset()

void BPY_driver_reset ( )

Update function, it gets rid of python-drivers global dictionary: bpy.app.driver_namespace, forcing BPY_driver_exec to recreate it. Use this when loading a new .blend file so any variables setup by the previous blend file are cleared.

Definition at line 264 of file bpy_driver.cc.

References BPY_driver_exit().

Referenced by BPY_python_reset().