Blender  V3.3
Classes | Macros
bpy_props.c File Reference
#include <Python.h>
#include "RNA_types.h"
#include "BLI_listbase.h"
#include "BLI_utildefines.h"
#include "bpy_capi_utils.h"
#include "bpy_props.h"
#include "bpy_rna.h"
#include "BKE_idprop.h"
#include "RNA_access.h"
#include "RNA_define.h"
#include "RNA_enum_types.h"
#include "RNA_prototypes.h"
#include "MEM_guardedalloc.h"
#include "DNA_ID.h"
#include "../generic/py_capi_rna.h"
#include "../generic/py_capi_utils.h"

Go to the source code of this file.

Classes

struct  BPyPropStore
 
struct  BPyPropArrayLength
 
struct  BPy_PropIDParse
 
struct  BPy_EnumProperty_Parse_WithSRNA
 

Macros

#define PY_SSIZE_T_CLEAN
 
#define ASSIGN_STATIC(_name)   pymeth_##_name = PyDict_GetItemString(submodule_dict, #_name)
 
Shared Enums & Doc-Strings
#define BPY_PROPDEF_OPTIONS_DOC
 
#define BPY_PROPDEF_OPTIONS_ENUM_DOC
 
#define BPY_PROPDEF_OPTIONS_OVERRIDE_DOC
 
#define BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC
 
#define BPY_PROPDEF_SUBTYPE_STRING_DOC
 
#define BPY_PROPDEF_SUBTYPE_NUMBER_DOC
 
#define BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC
 
Shared Method Doc-Strings
#define BPY_PROPDEF_NAME_DOC
 
#define BPY_PROPDEF_DESC_DOC
 
#define BPY_PROPDEF_UNIT_DOC
 
#define BPY_PROPDEF_NUM_MIN_DOC
 
#define BPY_PROPDEF_NUM_MAX_DOC
 
#define BPY_PROPDEF_NUM_SOFTMIN_DOC
 
#define BPY_PROPDEF_NUM_SOFTMAX_DOC
 
#define BPY_PROPDEF_VECSIZE_DOC
 
#define BPY_PROPDEF_INT_STEP_DOC
 
#define BPY_PROPDEF_FLOAT_STEP_DOC
 
#define BPY_PROPDEF_FLOAT_PREC_DOC
 
#define BPY_PROPDEF_UPDATE_DOC
 
#define BPY_PROPDEF_POLL_DOC
 
#define BPY_PROPDEF_GET_DOC
 
#define BPY_PROPDEF_SET_DOC
 
#define BPY_PROPDEF_SEARCH_DOC
 
#define BPY_PROPDEF_POINTER_TYPE_DOC
 
#define BPY_PROPDEF_COLLECTION_TYPE_DOC
 
#define BPY_PROPDEF_TAGS_DOC
 

Functions

Multi-Dimensional Property Utilities
static int bpy_prop_array_length_parse (PyObject *o, void *p)
 
static int bpy_prop_array_from_py_with_dims (void *values, size_t values_elem_size, PyObject *py_values, const struct BPyPropArrayLength *array_len_info, const PyTypeObject *type, const char *error_str)
 
static bool bpy_prop_array_is_matrix_compatible_ex (int subtype, const struct BPyPropArrayLength *array_len_info)
 
static bool bpy_prop_array_is_matrix_compatible (PropertyRNA *prop, const struct BPyPropArrayLength *array_len_info)
 
static void bpy_prop_array_matrix_swap_row_column_vn_vn (float *values_dst, const float *values_src, const struct BPyPropArrayLength *array_len_info)
 
static void bpy_prop_array_matrix_swap_row_column_vn (float *values, const struct BPyPropArrayLength *array_len_info)
 
Shared Property Callbacks

Unique data is accessed via RNA_property_py_data_get

static void bpy_prop_update_fn (struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop)
 
Boolean Property Callbacks
static bool bpy_prop_boolean_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop)
 
static void bpy_prop_boolean_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, bool value)
 
static void bpy_prop_boolean_array_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, bool *values)
 
static void bpy_prop_boolean_array_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, const bool *values)
 
Int Property Callbacks
static int bpy_prop_int_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop)
 
static void bpy_prop_int_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, int value)
 
static void bpy_prop_int_array_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, int *values)
 
static void bpy_prop_int_array_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, const int *values)
 
Float Property Callbacks
static float bpy_prop_float_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop)
 
static void bpy_prop_float_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, float value)
 
static void bpy_prop_float_array_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, float *values)
 
static void bpy_prop_float_array_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, const float *values)
 
String Property Callbacks
static void bpy_prop_string_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, char *value)
 
static int bpy_prop_string_length_fn (struct PointerRNA *ptr, struct PropertyRNA *prop)
 
static void bpy_prop_string_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, const char *value)
 
static bool bpy_prop_string_visit_fn_call (PyObject *py_func, PyObject *item, StringPropertySearchVisitFunc visit_fn, void *visit_user_data)
 
static void bpy_prop_string_visit_for_search_fn (const struct bContext *C, struct PointerRNA *ptr, struct PropertyRNA *prop, const char *edit_text, StringPropertySearchVisitFunc visit_fn, void *visit_user_data)
 
Pointer Property Callbacks
static bool bpy_prop_pointer_poll_fn (struct PointerRNA *self, PointerRNA candidate, struct PropertyRNA *prop)
 
Enum Property Callbacks
static int bpy_prop_enum_get_fn (struct PointerRNA *ptr, struct PropertyRNA *prop)
 
static void bpy_prop_enum_set_fn (struct PointerRNA *ptr, struct PropertyRNA *prop, int value)
 
static bool py_long_as_int (PyObject *py_long, int *r_int)
 
static int icon_id_from_name (const char *name)
 
static const EnumPropertyItemenum_items_from_py (PyObject *seq_fast, const bool is_enum_flag, PyObject *default_py, int *r_default_value)
 
static const EnumPropertyItembpy_prop_enum_itemf_fn (struct bContext *C, PointerRNA *ptr, PropertyRNA *prop, bool *r_free)
 
static int bpy_prop_callback_check (PyObject *py_func, const char *keyword, int argcount)
 
Shared Callback Assignment
static void bpy_prop_callback_assign_update (struct PropertyRNA *prop, PyObject *update_fn)
 
static void bpy_prop_callback_assign_pointer (struct PropertyRNA *prop, PyObject *poll_fn)
 
static void bpy_prop_callback_assign_boolean (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn)
 
static void bpy_prop_callback_assign_boolean_array (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn)
 
static void bpy_prop_callback_assign_int (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn)
 
static void bpy_prop_callback_assign_int_array (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn)
 
static void bpy_prop_callback_assign_float (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn)
 
static void bpy_prop_callback_assign_float_array (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn)
 
static void bpy_prop_callback_assign_string (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn, PyObject *search_fn, const eStringPropertySearchFlag search_flag)
 
static void bpy_prop_callback_assign_enum (struct PropertyRNA *prop, PyObject *get_fn, PyObject *set_fn, PyObject *itemf_fn)
 
Shared Method Utilities
static StructRNAbpy_prop_deferred_data_or_srna (PyObject *self, PyObject *args, PyObject *kw, PyObject *method_object, PyObject **r_deferred_result)
 
static int bpy_prop_arg_parse_id (PyObject *o, void *p)
 
static int bpy_prop_arg_parse_tag_defines (PyObject *o, void *p)
 
Module Methods

Functions that register RNA.

Note
The self argument is NULL when called from Python, but being abused from C so we can pass the srna along. This isn't incorrect since its a Python object - but be careful.
 PyDoc_STRVAR (BPy_BoolProperty_doc, ".. function:: BoolProperty(name=\"\", " "description=\"\", " "default=False, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new boolean property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_BoolProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_BoolVectorProperty_doc, ".. function:: BoolVectorProperty(name=\"\", " "description=\"\", " "default=(False, False, False), " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector boolean property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of booleans the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_BoolVectorProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_IntProperty_doc, ".. function:: IntProperty(name=\"\", " "description=\"\", " "default=0, " "min=-2**31, max=2**31-1, " "soft_min=-2**31, soft_max=2**31-1, " "step=1, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new int property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC " :type min: int\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: int\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_min: int\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_max: int\n" BPY_PROPDEF_INT_STEP_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_IntProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_IntVectorProperty_doc, ".. function:: IntVectorProperty(name=\"\", " "description=\"\", " "default=(0, 0, 0), min=-2**31, max=2**31-1, " "soft_min=-2**31, " "soft_max=2**31-1, " "step=1, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector int property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of ints the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_NUM_MIN_DOC " :type min: int\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: int\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: int\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: int\n" BPY_PROPDEF_INT_STEP_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_IntVectorProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_FloatProperty_doc, ".. function:: FloatProperty(name=\"\", " "description=\"\", " "default=0.0, " "min=-3.402823e+38, max=3.402823e+38, " "soft_min=-3.402823e+38, soft_max=3.402823e+38, " "step=3, " "precision=2, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "unit='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new float (single precision) property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC " :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: float\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: float\n" BPY_PROPDEF_FLOAT_STEP_DOC BPY_PROPDEF_FLOAT_PREC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UNIT_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_FloatProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_FloatVectorProperty_doc, ".. function:: FloatVectorProperty(name=\"\", " "description=\"\", " "default=(0.0, 0.0, 0.0), " "min=sys.float_info.min, max=sys.float_info.max, " "soft_min=sys.float_info.min, soft_max=sys.float_info.max, " "step=3, " "precision=2, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "unit='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector float property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of floats the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_NUM_MIN_DOC " :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: float\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: float\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_FLOAT_STEP_DOC BPY_PROPDEF_FLOAT_PREC_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_UNIT_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_FloatVectorProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_StringProperty_doc, ".. function:: StringProperty(name=\"\", " "description=\"\", " "default=\"\", " "maxlen=0, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None, " "search=None, " "search_options={'SUGGESTION'})\n" "\n" " Returns a new string property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: initializer string.\n" " :type default: string\n" " :arg maxlen: maximum length of the string.\n" " :type maxlen: int\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_STRING_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC BPY_PROPDEF_SEARCH_DOC)
 
static PyObject * BPy_StringProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_EnumProperty_doc, ".. function:: EnumProperty(items, " "name=\"\", " "description=\"\", " "default=None, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new enumerator property definition.\n" "\n" " :arg items: sequence of enum items formatted:\n" " ``[(identifier, name, description, icon, number), ...]``.\n" "\n" " The first three elements of the tuples are mandatory.\n" "\n" " :identifier: The identifier is used for Python access.\n" " :name: Name for the interface.\n" " :description: Used for documentation and tooltips.\n" " :icon: An icon string identifier or integer icon value\n" " (e.g. returned by :class:`bpy.types.UILayout.icon`)\n" " :number: Unique value used as the identifier for this item (stored in file data).\n" " Use when the identifier may need to change. If the *ENUM_FLAG* option is used,\n" " the values are bit-masks and should be powers of two.\n" "\n" " When an item only contains 4 items they define ``(identifier, name, description, " "number)``.\n" "\n" " Separators may be added using None instead of a tuple." "\n" " For dynamic values a callback can be passed which returns a list in\n" " the same format as the static list.\n" " This function must take 2 arguments ``(self, context)``, **context may be None**.\n" "\n" " .. warning::\n" "\n" " There is a known bug with using a callback,\n" " Python must keep a reference to the strings returned by the callback or Blender\n" " will misbehave or even crash." "\n" " :type items: sequence of string tuples or a function\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: The default value for this enum, a string from the identifiers used in " "*items*, or integer matching an item number.\n" " If the *ENUM_FLAG* option is used this must be a set of such string identifiers " "instead.\n" " WARNING: Strings can not be specified for dynamic enums\n" " (i.e. if a callback function is given as *items* parameter).\n" " :type default: string, integer or set\n" BPY_PROPDEF_OPTIONS_ENUM_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC)
 
static PyObject * BPy_EnumProperty (PyObject *self, PyObject *args, PyObject *kw)
 
StructRNApointer_type_from_py (PyObject *value, const char *error_prefix)
 
 PyDoc_STRVAR (BPy_PointerProperty_doc, ".. function:: PointerProperty(type=None, " "name=\"\", " "description=\"\", " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "poll=None, " "update=None)\n" "\n" " Returns a new pointer property definition.\n" "\n" BPY_PROPDEF_POINTER_TYPE_DOC BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_POLL_DOC BPY_PROPDEF_UPDATE_DOC)
 
PyObject * BPy_PointerProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_CollectionProperty_doc, ".. function:: CollectionProperty(type=None, " "name=\"\", " "description=\"\", " "options={'ANIMATABLE'}, " "override=set(), " "tags=set())\n" "\n" " Returns a new collection property definition.\n" "\n" BPY_PROPDEF_COLLECTION_TYPE_DOC BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC BPY_PROPDEF_TAGS_DOC)
 
PyObject * BPy_CollectionProperty (PyObject *self, PyObject *args, PyObject *kw)
 
 PyDoc_STRVAR (BPy_RemoveProperty_doc, ".. function:: RemoveProperty(cls, attr)\n" "\n" " Removes a dynamically defined property.\n" "\n" " :arg cls: The class containing the property (must be a positional argument).\n" " :type cls: type\n" " :arg attr: Property name (must be passed as a keyword).\n" " :type attr: string\n" "\n" ".. note:: Typically this function doesn't need to be accessed directly.\n" " Instead use ``del cls.attr``\n")
 
static PyObject * BPy_RemoveProperty (PyObject *self, PyObject *args, PyObject *kw)
 

Python Property Storage API

Functionality needed to use Python native callbacks from generic C RNA callbacks.

#define BPY_PROP_STORE_PY_DATA_SIZE    (sizeof(((struct BPyPropStore *)NULL)->py_data) / sizeof(PyObject *))
 
#define ASSIGN_PYOBJECT_INCREF(a, b)
 
static ListBase g_bpy_prop_store_list = {NULL, NULL}
 
static struct BPyPropStorebpy_prop_py_data_ensure (struct PropertyRNA *prop)
 
static void bpy_prop_py_data_remove (PropertyRNA *prop)
 

Deferred Property Type

Operators and classes use this so it can store the arguments given but defer running it until the operator runs where these values are used to setup the default arguments for that operator instance.

static PyGetSetDef bpy_prop_deferred_getset []
 
PyTypeObject bpy_prop_deferred_Type
 
static void bpy_prop_deferred_dealloc (BPy_PropDeferred *self)
 
static int bpy_prop_deferred_traverse (BPy_PropDeferred *self, visitproc visit, void *arg)
 
static int bpy_prop_deferred_clear (BPy_PropDeferred *self)
 
static PyObject * bpy_prop_deferred_repr (BPy_PropDeferred *self)
 
static PyObject * bpy_prop_deferred_call (BPy_PropDeferred *UNUSED(self), PyObject *UNUSED(args), PyObject *UNUSED(kw))
 
static PyObject * bpy_prop_deferred_function_get (BPy_PropDeferred *self, void *UNUSED(closure))
 
static PyObject * bpy_prop_deferred_keywords_get (BPy_PropDeferred *self, void *UNUSED(closure))
 
 PyDoc_STRVAR (bpy_prop_deferred_doc, "Intermediate storage for properties before registration.\n" "\n" ".. note::\n" "\n" " This is not part of the stable API and may change between releases.")
 
static PyObject * bpy_prop_deferred_data_CreatePyObject (PyObject *fn, PyObject *kw)
 

Shared Property Utilities

static PyObject * pymeth_BoolProperty = NULL
 
static PyObject * pymeth_BoolVectorProperty = NULL
 
static PyObject * pymeth_IntProperty = NULL
 
static PyObject * pymeth_IntVectorProperty = NULL
 
static PyObject * pymeth_FloatProperty = NULL
 
static PyObject * pymeth_FloatVectorProperty = NULL
 
static PyObject * pymeth_StringProperty = NULL
 
static PyObject * pymeth_EnumProperty = NULL
 
static PyObject * pymeth_PointerProperty = NULL
 
static PyObject * pymeth_CollectionProperty = NULL
 
static PyObject * pymeth_RemoveProperty = NULL
 
static PyObject * pyrna_struct_as_instance (PointerRNA *ptr)
 
static void bpy_prop_assign_flag (PropertyRNA *prop, const int flag)
 
static void bpy_prop_assign_flag_override (PropertyRNA *prop, const int flag_override)
 

Main Module <tt>bpy.props</tt>

static struct PyMethodDef props_methods []
 
static struct PyModuleDef props_module
 
static int props_visit (PyObject *UNUSED(self), visitproc visit, void *arg)
 
static int props_clear (PyObject *UNUSED(self))
 
PyObject * BPY_rna_props (void)
 
void BPY_rna_props_clear_all (void)
 

Detailed Description

This file defines 'bpy.props' module used so scripts can define their own rna properties for use with python operators or adding new properties to existing blender types.

Definition in file bpy_props.c.

Macro Definition Documentation

◆ ASSIGN_PYOBJECT_INCREF

#define ASSIGN_PYOBJECT_INCREF (   a,
 
)
Value:
{ \
BLI_assert((a) == NULL); \
Py_INCREF(b); \
a = b; \
} \
((void)0)
SyclQueue void void size_t num_bytes void
static unsigned a[3]
Definition: RandGen.cpp:78
static const pxr::TfToken b("b", pxr::TfToken::Immortal)

Definition at line 154 of file bpy_props.c.

◆ ASSIGN_STATIC

#define ASSIGN_STATIC (   _name)    pymeth_##_name = PyDict_GetItemString(submodule_dict, #_name)

◆ BPY_PROP_STORE_PY_DATA_SIZE

#define BPY_PROP_STORE_PY_DATA_SIZE    (sizeof(((struct BPyPropStore *)NULL)->py_data) / sizeof(PyObject *))

Definition at line 151 of file bpy_props.c.

◆ BPY_PROPDEF_COLLECTION_TYPE_DOC

#define BPY_PROPDEF_COLLECTION_TYPE_DOC
Value:
" :arg type: A subclass of :class:`bpy.types.PropertyGroup`.\n" \
" :type type: class\n"

Definition at line 2708 of file bpy_props.c.

◆ BPY_PROPDEF_DESC_DOC

#define BPY_PROPDEF_DESC_DOC
Value:
" :arg description: Text used for the tooltip and api documentation.\n" \
" :type description: string\n"

Definition at line 2619 of file bpy_props.c.

◆ BPY_PROPDEF_FLOAT_PREC_DOC

#define BPY_PROPDEF_FLOAT_PREC_DOC
Value:
" :arg precision: Maximum number of decimal digits to display, in [0, 6]. Fraction is " \
"automatically hidden for exact integer values of fields with unit 'NONE' or 'TIME' (frame " \
"count) and step divisible by 100.\n" \
" :type precision: int\n"

Definition at line 2658 of file bpy_props.c.

◆ BPY_PROPDEF_FLOAT_STEP_DOC

#define BPY_PROPDEF_FLOAT_STEP_DOC
Value:
" :arg step: Step of increment/decrement in UI, in [1, 100], defaults to 3 (WARNING: actual " \
"value is /100).\n" \
" :type step: int\n"

Definition at line 2653 of file bpy_props.c.

◆ BPY_PROPDEF_GET_DOC

#define BPY_PROPDEF_GET_DOC
Value:
" :arg get: Function to be called when this value is 'read',\n" \
" This function must take 1 value (self) and return the value of the property.\n" \
" :type get: function\n"

Definition at line 2676 of file bpy_props.c.

◆ BPY_PROPDEF_INT_STEP_DOC

#define BPY_PROPDEF_INT_STEP_DOC
Value:
" :arg step: Step of increment/decrement in UI, in [1, 100], defaults to 1 (WARNING: unused " \
"currently!).\n" \
" :type step: int\n"

Definition at line 2648 of file bpy_props.c.

◆ BPY_PROPDEF_NAME_DOC

#define BPY_PROPDEF_NAME_DOC
Value:
" :arg name: Name used in the user interface.\n" \
" :type name: string\n"

Definition at line 2615 of file bpy_props.c.

◆ BPY_PROPDEF_NUM_MAX_DOC

#define BPY_PROPDEF_NUM_MAX_DOC
Value:
" :arg max: Hard maximum, trying to assign a value above will silently assign this maximum " \
"instead.\n"

Definition at line 2631 of file bpy_props.c.

◆ BPY_PROPDEF_NUM_MIN_DOC

#define BPY_PROPDEF_NUM_MIN_DOC
Value:
" :arg min: Hard minimum, trying to assign a value below will silently assign this minimum " \
"instead.\n"

Definition at line 2627 of file bpy_props.c.

◆ BPY_PROPDEF_NUM_SOFTMAX_DOC

#define BPY_PROPDEF_NUM_SOFTMAX_DOC
Value:
" :arg soft_max: Soft maximum (<= *max*), user won't be able to drag the widget above this " \
"value in the UI.\n"

Definition at line 2639 of file bpy_props.c.

◆ BPY_PROPDEF_NUM_SOFTMIN_DOC

#define BPY_PROPDEF_NUM_SOFTMIN_DOC
Value:
" :arg soft_min: Soft minimum (>= *min*), user won't be able to drag the widget below this " \
"value in the UI.\n"

Definition at line 2635 of file bpy_props.c.

◆ BPY_PROPDEF_OPTIONS_DOC

#define BPY_PROPDEF_OPTIONS_DOC
Value:
" :arg options: Enumerator in :ref:`rna_enum_property_flag_items`.\n" \
" :type options: set\n"

Definition at line 48 of file bpy_props.c.

◆ BPY_PROPDEF_OPTIONS_ENUM_DOC

#define BPY_PROPDEF_OPTIONS_ENUM_DOC
Value:
" :arg options: Enumerator in :ref:`rna_enum_property_flag_enum_items`.\n" \
" :type options: set\n"

Definition at line 52 of file bpy_props.c.

◆ BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC

#define BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC
Value:
" :arg override: Enumerator in :ref:`rna_enum_property_override_flag_collection_items`.\n" \
" :type override: set\n"

Definition at line 60 of file bpy_props.c.

◆ BPY_PROPDEF_OPTIONS_OVERRIDE_DOC

#define BPY_PROPDEF_OPTIONS_OVERRIDE_DOC
Value:
" :arg override: Enumerator in :ref:`rna_enum_property_override_flag_items`.\n" \
" :type override: set\n"

Definition at line 56 of file bpy_props.c.

◆ BPY_PROPDEF_POINTER_TYPE_DOC

#define BPY_PROPDEF_POINTER_TYPE_DOC
Value:
" :arg type: A subclass of :class:`bpy.types.PropertyGroup` or :class:`bpy.types.ID`.\n" \
" :type type: class\n"

Definition at line 2704 of file bpy_props.c.

◆ BPY_PROPDEF_POLL_DOC

#define BPY_PROPDEF_POLL_DOC
Value:
" :arg poll: function to be called to determine whether an item is valid for this " \
"property.\n" \
" The function must take 2 values (self, object) and return Bool.\n" \
" :type poll: function\n"

Definition at line 2670 of file bpy_props.c.

◆ BPY_PROPDEF_SEARCH_DOC

#define BPY_PROPDEF_SEARCH_DOC
Value:
" :arg search: Function to be called to show candidates for this string (shown in the UI).\n" \
" This function must take 3 values (self, context, edit_text)\n" \
" and return a sequence, iterator or generator where each item must be:\n" \
"\n" \
" - A single string (representing a candidate to display).\n" \
" - A tuple-pair of strings, where the first is a candidate and the second\n" \
" is additional information about the candidate.\n" \
" :type search: function\n" \
" :arg search_options: Set of strings in:\n" \
"\n" \
" - 'SORT' sorts the resulting items.\n" \
" - 'SUGGESTION' lets the user enter values not found in search candidates.\n" \
" **WARNING** disabling this flag causes the search callback to run on redraw,\n" \
" so only disable this flag if it's not likely to cause performance issues.\n" \
"\n" \
" :type search_options: set\n"

Definition at line 2686 of file bpy_props.c.

◆ BPY_PROPDEF_SET_DOC

#define BPY_PROPDEF_SET_DOC
Value:
" :arg set: Function to be called when this value is 'written',\n" \
" This function must take 2 values (self, value) and return None.\n" \
" :type set: function\n"

Definition at line 2681 of file bpy_props.c.

◆ BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC

#define BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC
Value:
" :arg subtype: Enumerator in :ref:`rna_enum_property_subtype_number_array_items`.\n" \
" :type subtype: string\n"

Definition at line 72 of file bpy_props.c.

◆ BPY_PROPDEF_SUBTYPE_NUMBER_DOC

#define BPY_PROPDEF_SUBTYPE_NUMBER_DOC
Value:
" :arg subtype: Enumerator in :ref:`rna_enum_property_subtype_number_items`.\n" \
" :type subtype: string\n"

Definition at line 68 of file bpy_props.c.

◆ BPY_PROPDEF_SUBTYPE_STRING_DOC

#define BPY_PROPDEF_SUBTYPE_STRING_DOC
Value:
" :arg subtype: Enumerator in :ref:`rna_enum_property_subtype_string_items`.\n" \
" :type subtype: string\n"

Definition at line 64 of file bpy_props.c.

◆ BPY_PROPDEF_TAGS_DOC

#define BPY_PROPDEF_TAGS_DOC
Value:
" :arg tags: Enumerator of tags that are defined by parent class.\n" \
" :type tags: set\n"

Definition at line 2712 of file bpy_props.c.

◆ BPY_PROPDEF_UNIT_DOC

#define BPY_PROPDEF_UNIT_DOC
Value:
" :arg unit: Enumerator in :ref:`rna_enum_property_unit_items`.\n" \
" :type unit: string\n"

Definition at line 2623 of file bpy_props.c.

◆ BPY_PROPDEF_UPDATE_DOC

#define BPY_PROPDEF_UPDATE_DOC
Value:
" :arg update: Function to be called when this value is modified,\n" \
" This function must take 2 values (self, context) and return None.\n" \
" *Warning* there are no safety checks to avoid infinite recursion.\n" \
" :type update: function\n"

Definition at line 2664 of file bpy_props.c.

◆ BPY_PROPDEF_VECSIZE_DOC

#define BPY_PROPDEF_VECSIZE_DOC
Value:
" :arg size: Vector dimensions in [1, " STRINGIFY(PYRNA_STACK_ARRAY) "]. " \
"An int sequence can be used to define multi-dimension arrays.\n" \
" :type size: int or int sequence\n"
#define STRINGIFY(x)
#define PYRNA_STACK_ARRAY
Definition: bpy_props.h:37

Definition at line 2643 of file bpy_props.c.

◆ PY_SSIZE_T_CLEAN

#define PY_SSIZE_T_CLEAN

Definition at line 12 of file bpy_props.c.

Function Documentation

◆ BPy_BoolProperty()

static PyObject* BPy_BoolProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_BoolVectorProperty()

static PyObject* BPy_BoolVectorProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_CollectionProperty()

PyObject* BPy_CollectionProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)

◆ BPy_EnumProperty()

static PyObject* BPy_EnumProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_FloatProperty()

static PyObject* BPy_FloatProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_FloatVectorProperty()

static PyObject* BPy_FloatVectorProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_IntProperty()

static PyObject* BPy_IntProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_IntVectorProperty()

static PyObject* BPy_IntVectorProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPy_PointerProperty()

PyObject* BPy_PointerProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)

◆ bpy_prop_arg_parse_id()

static int bpy_prop_arg_parse_id ( PyObject *  o,
void p 
)
static

◆ bpy_prop_arg_parse_tag_defines()

static int bpy_prop_arg_parse_tag_defines ( PyObject *  o,
void p 
)
static

◆ bpy_prop_array_from_py_with_dims()

static int bpy_prop_array_from_py_with_dims ( void values,
size_t  values_elem_size,
PyObject *  py_values,
const struct BPyPropArrayLength array_len_info,
const PyTypeObject *  type,
const char *  error_str 
)
static

◆ bpy_prop_array_is_matrix_compatible()

static bool bpy_prop_array_is_matrix_compatible ( PropertyRNA prop,
const struct BPyPropArrayLength array_len_info 
)
static

◆ bpy_prop_array_is_matrix_compatible_ex()

static bool bpy_prop_array_is_matrix_compatible_ex ( int  subtype,
const struct BPyPropArrayLength array_len_info 
)
static

◆ bpy_prop_array_length_parse()

static int bpy_prop_array_length_parse ( PyObject *  o,
void p 
)
static

◆ bpy_prop_array_matrix_swap_row_column_vn()

static void bpy_prop_array_matrix_swap_row_column_vn ( float values,
const struct BPyPropArrayLength array_len_info 
)
static

◆ bpy_prop_array_matrix_swap_row_column_vn_vn()

static void bpy_prop_array_matrix_swap_row_column_vn_vn ( float values_dst,
const float values_src,
const struct BPyPropArrayLength array_len_info 
)
static

Needed since the internal storage of matrices swaps row/column.

Definition at line 491 of file bpy_props.c.

References BLI_assert, and BPyPropArrayLength::dims.

Referenced by bpy_prop_array_matrix_swap_row_column_vn().

◆ bpy_prop_assign_flag()

static void bpy_prop_assign_flag ( PropertyRNA prop,
const int  flag 
)
static

◆ bpy_prop_assign_flag_override()

static void bpy_prop_assign_flag_override ( PropertyRNA prop,
const int  flag_override 
)
static

◆ bpy_prop_boolean_array_get_fn()

static void bpy_prop_boolean_array_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
bool values 
)
static

◆ bpy_prop_boolean_array_set_fn()

static void bpy_prop_boolean_array_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
const bool values 
)
static

◆ bpy_prop_boolean_get_fn()

static bool bpy_prop_boolean_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop 
)
static

◆ bpy_prop_boolean_set_fn()

static void bpy_prop_boolean_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
bool  value 
)
static

◆ bpy_prop_callback_assign_boolean()

static void bpy_prop_callback_assign_boolean ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn 
)
static

◆ bpy_prop_callback_assign_boolean_array()

static void bpy_prop_callback_assign_boolean_array ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn 
)
static

◆ bpy_prop_callback_assign_enum()

static void bpy_prop_callback_assign_enum ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn,
PyObject *  itemf_fn 
)
static

◆ bpy_prop_callback_assign_float()

static void bpy_prop_callback_assign_float ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn 
)
static

◆ bpy_prop_callback_assign_float_array()

static void bpy_prop_callback_assign_float_array ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn 
)
static

◆ bpy_prop_callback_assign_int()

static void bpy_prop_callback_assign_int ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn 
)
static

◆ bpy_prop_callback_assign_int_array()

static void bpy_prop_callback_assign_int_array ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn 
)
static

◆ bpy_prop_callback_assign_pointer()

static void bpy_prop_callback_assign_pointer ( struct PropertyRNA prop,
PyObject *  poll_fn 
)
static

◆ bpy_prop_callback_assign_string()

static void bpy_prop_callback_assign_string ( struct PropertyRNA prop,
PyObject *  get_fn,
PyObject *  set_fn,
PyObject *  search_fn,
const eStringPropertySearchFlag  search_flag 
)
static

◆ bpy_prop_callback_assign_update()

static void bpy_prop_callback_assign_update ( struct PropertyRNA prop,
PyObject *  update_fn 
)
static

◆ bpy_prop_callback_check()

static int bpy_prop_callback_check ( PyObject *  py_func,
const char *  keyword,
int  argcount 
)
static

◆ bpy_prop_deferred_call()

static PyObject* bpy_prop_deferred_call ( BPy_PropDeferred UNUSEDself,
PyObject *  UNUSEDargs,
PyObject *  UNUSEDkw 
)
static

HACK: needed by typing.get_type_hints with from __future__ import annotations enabled or when using Python 3.10 or newer.

When callable this object type passes the test for being an acceptable annotation.

Definition at line 236 of file bpy_props.c.

◆ bpy_prop_deferred_clear()

static int bpy_prop_deferred_clear ( BPy_PropDeferred self)
static

Definition at line 219 of file bpy_props.c.

References self.

◆ bpy_prop_deferred_data_CreatePyObject()

static PyObject* bpy_prop_deferred_data_CreatePyObject ( PyObject *  fn,
PyObject *  kw 
)
static

Definition at line 299 of file bpy_props.c.

References bpy_prop_deferred_Type, and NULL.

Referenced by bpy_prop_deferred_data_or_srna().

◆ bpy_prop_deferred_data_or_srna()

static StructRNA* bpy_prop_deferred_data_or_srna ( PyObject *  self,
PyObject *  args,
PyObject *  kw,
PyObject *  method_object,
PyObject **  r_deferred_result 
)
static

This define runs at the start of each function and deals with returning a deferred property BPy_PropDeferred (to be registered later).

Parameters
selfThe self argument from the caller.
argsThe positional arguments of the caller.
kwThe keyword arguments of the caller.
method_objectThe method of the caller (unfortunately this can't be deduced).
r_deferred_resultThe deferred result (or NULL in the case of an error). The caller must return this value unless a valid srna is returned.
Returns
When not null, the caller is expected to perform the registration.

Definition at line 2486 of file bpy_props.c.

References BLI_assert, bpy_prop_deferred_data_CreatePyObject(), NULL, and srna_from_self().

Referenced by BPy_BoolProperty(), BPy_BoolVectorProperty(), BPy_CollectionProperty(), BPy_EnumProperty(), BPy_FloatProperty(), BPy_FloatVectorProperty(), BPy_IntProperty(), BPy_IntVectorProperty(), BPy_PointerProperty(), and BPy_StringProperty().

◆ bpy_prop_deferred_dealloc()

static void bpy_prop_deferred_dealloc ( BPy_PropDeferred self)
static

Definition at line 206 of file bpy_props.c.

References self.

◆ bpy_prop_deferred_function_get()

static PyObject* bpy_prop_deferred_function_get ( BPy_PropDeferred self,
void UNUSEDclosure 
)
static

Expose the function in case scripts need to introspect this information (not currently used by Blender itself).

Definition at line 250 of file bpy_props.c.

References ret.

◆ bpy_prop_deferred_keywords_get()

static PyObject* bpy_prop_deferred_keywords_get ( BPy_PropDeferred self,
void UNUSEDclosure 
)
static

Expose keywords in case scripts need to introspect this information (not currently used by Blender itself).

Definition at line 261 of file bpy_props.c.

References ret.

◆ bpy_prop_deferred_repr()

static PyObject* bpy_prop_deferred_repr ( BPy_PropDeferred self)
static

Definition at line 225 of file bpy_props.c.

References self.

◆ bpy_prop_deferred_traverse()

static int bpy_prop_deferred_traverse ( BPy_PropDeferred self,
visitproc  visit,
void arg 
)
static

Definition at line 213 of file bpy_props.c.

References self.

◆ bpy_prop_enum_get_fn()

static int bpy_prop_enum_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop 
)
static

◆ bpy_prop_enum_itemf_fn()

static const EnumPropertyItem* bpy_prop_enum_itemf_fn ( struct bContext C,
PointerRNA ptr,
PropertyRNA prop,
bool r_free 
)
static

◆ bpy_prop_enum_set_fn()

static void bpy_prop_enum_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
int  value 
)
static

◆ bpy_prop_float_array_get_fn()

static void bpy_prop_float_array_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
float values 
)
static

◆ bpy_prop_float_array_set_fn()

static void bpy_prop_float_array_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
const float values 
)
static

◆ bpy_prop_float_get_fn()

static float bpy_prop_float_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop 
)
static

◆ bpy_prop_float_set_fn()

static void bpy_prop_float_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
float  value 
)
static

◆ bpy_prop_int_array_get_fn()

static void bpy_prop_int_array_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
int *  values 
)
static

◆ bpy_prop_int_array_set_fn()

static void bpy_prop_int_array_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
const int *  values 
)
static

◆ bpy_prop_int_get_fn()

static int bpy_prop_int_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop 
)
static

◆ bpy_prop_int_set_fn()

static void bpy_prop_int_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
int  value 
)
static

◆ bpy_prop_pointer_poll_fn()

static bool bpy_prop_pointer_poll_fn ( struct PointerRNA self,
PointerRNA  candidate,
struct PropertyRNA prop 
)
static

◆ bpy_prop_py_data_ensure()

static struct BPyPropStore* bpy_prop_py_data_ensure ( struct PropertyRNA prop)
static

◆ bpy_prop_py_data_remove()

static void bpy_prop_py_data_remove ( PropertyRNA prop)
static

Perform all removal actions except for freeing, which is handled by RNA.

Definition at line 182 of file bpy_props.c.

References BLI_remlink(), BPY_PROP_STORE_PY_DATA_SIZE, g_bpy_prop_store_list, NULL, BPyPropStore::py_data, and RNA_property_py_data_get().

Referenced by BPY_rna_props().

◆ bpy_prop_string_get_fn()

static void bpy_prop_string_get_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
char *  value 
)
static

◆ bpy_prop_string_length_fn()

static int bpy_prop_string_length_fn ( struct PointerRNA ptr,
struct PropertyRNA prop 
)
static

◆ bpy_prop_string_set_fn()

static void bpy_prop_string_set_fn ( struct PointerRNA ptr,
struct PropertyRNA prop,
const char *  value 
)
static

◆ bpy_prop_string_visit_fn_call()

static bool bpy_prop_string_visit_fn_call ( PyObject *  py_func,
PyObject *  item,
StringPropertySearchVisitFunc  visit_fn,
void visit_user_data 
)
static

◆ bpy_prop_string_visit_for_search_fn()

static void bpy_prop_string_visit_for_search_fn ( const struct bContext C,
struct PointerRNA ptr,
struct PropertyRNA prop,
const char *  edit_text,
StringPropertySearchVisitFunc  visit_fn,
void visit_user_data 
)
static

◆ bpy_prop_update_fn()

static void bpy_prop_update_fn ( struct bContext C,
struct PointerRNA ptr,
struct PropertyRNA prop 
)
static

◆ BPy_RemoveProperty()

static PyObject* BPy_RemoveProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ BPY_rna_props()

PyObject* BPY_rna_props ( void  )

◆ BPY_rna_props_clear_all()

void BPY_rna_props_clear_all ( void  )

Run this on exit, clearing all Python callback users and disable the RNA callback, as it would be called after Python has already finished.

Definition at line 4676 of file bpy_props.c.

References BLI_listbase_clear(), g_bpy_prop_store_list, NULL, props_clear(), and RNA_def_property_free_pointers_set_py_data_callback().

Referenced by BPY_python_end().

◆ BPy_StringProperty()

static PyObject* BPy_StringProperty ( PyObject *  self,
PyObject *  args,
PyObject *  kw 
)
static

◆ enum_items_from_py()

static const EnumPropertyItem* enum_items_from_py ( PyObject *  seq_fast,
const bool  is_enum_flag,
PyObject *  default_py,
int *  r_default_value 
)
static

◆ icon_id_from_name()

static int icon_id_from_name ( const char *  name)
static

◆ pointer_type_from_py()

StructRNA* pointer_type_from_py ( PyObject *  value,
const char *  error_prefix 
)

◆ props_clear()

static int props_clear ( PyObject *  UNUSEDself)
static

◆ props_visit()

static int props_visit ( PyObject *  UNUSEDself,
visitproc  visit,
void arg 
)
static

◆ py_long_as_int()

static bool py_long_as_int ( PyObject *  py_long,
int *  r_int 
)
static

Definition at line 1897 of file bpy_props.c.

Referenced by BPy_EnumProperty(), and enum_items_from_py().

◆ PyDoc_STRVAR() [1/12]

PyDoc_STRVAR ( BPy_BoolProperty_doc  ,
".. function:: BoolProperty(name=\"\", " "description=\"\", " "default=False, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new boolean property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [2/12]

PyDoc_STRVAR ( BPy_BoolVectorProperty_doc  ,
".. function:: BoolVectorProperty(name=\"\", " "description=\"\", " "default=(False, False, False), " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector boolean property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of booleans the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [3/12]

PyDoc_STRVAR ( BPy_CollectionProperty_doc  ,
".. function:: CollectionProperty(type=None, " "name=\"\", " "description=\"\", " "options={'ANIMATABLE'}, " "override=set(), " "tags=set())\n" "\n" " Returns a new collection property definition.\n" "\n" BPY_PROPDEF_COLLECTION_TYPE_DOC BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_COLLECTION_DOC  BPY_PROPDEF_TAGS_DOC 
)

◆ PyDoc_STRVAR() [4/12]

PyDoc_STRVAR ( BPy_EnumProperty_doc  ,
".. function:: EnumProperty(items, " "name=\"\", " "description=\"\", " "default=None, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new enumerator property definition.\n" "\n" " :arg items: sequence of enum items formatted:\n" " ````.\n" "\n" " The first three elements of the tuples are mandatory.\n" "\n" " :identifier: The identifier is used for Python access.\n" " :name: Name for the interface.\n" " :description: Used for documentation and tooltips.\n" " :icon: An icon string identifier or integer icon value\n" " (e.g. returned by :class:`bpy.types.UILayout.icon`)\n" " :number: Unique value used as the identifier for this item (stored in file data).\n" " Use when the identifier may need to change. If the *ENUM_FLAG* option is  used[(identifier, name, description, icon, number),...],
\n" " the values are bit-masks and should be powers of two.\n" "\n" " When an item only contains 4 items they define ``(identifier, name, description, " "number)``.\n" "\n" " Separators may be added using None instead of a tuple." "\n" " For dynamic values a callback can be passed which returns a list in\n" " the same format as the static list.\n" " This function must take 2 arguments ``(self, context)``  ,
**context may be None **.\n" "\n" " .. warning::\n" "\n" " There is a known bug with using a  callback,
\n" " Python must keep a reference to the strings returned by the callback or Blender\n" " will misbehave or even crash." "\n" " :type items:sequence of string tuples or a function\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default:The default value for this  enum,
a string from the identifiers used in " " *items *  ,
or integer matching an item number.\n" " If the *ENUM_FLAG *option is used this must be a set of such string identifiers " "instead.\n" " WARNING:Strings can not be specified for dynamic enums\n" "(i.e. if a callback function is given as *items *parameter).\n" " :type default:string  ,
integer or set\n" BPY_PROPDEF_OPTIONS_ENUM_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [5/12]

PyDoc_STRVAR ( BPy_FloatProperty_doc  ,
".. function:: FloatProperty(name=\"\", " "description=\"\", " "default=0.0, " "min=-3.402823e+38, max=3.402823e+38, " "soft_min=-3.402823e+38, soft_max=3.402823e+38, " "step=3, " "precision=2, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "unit='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new float (single precision) property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC " :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: float\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: float\n" BPY_PROPDEF_FLOAT_STEP_DOC BPY_PROPDEF_FLOAT_PREC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UNIT_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [6/12]

PyDoc_STRVAR ( BPy_FloatVectorProperty_doc  ,
".. function:: FloatVectorProperty(name=\"\", " "description=\"\", " "default=(0.0, 0.0, 0.0), " "min=sys.float_info.min, max=sys.float_info.max, " "soft_min=sys.float_info.min, soft_max=sys.float_info.max, " "step=3, " "precision=2, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "unit='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector float property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of floats the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_NUM_MIN_DOC " :type min: float\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: float\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: float\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: float\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_FLOAT_STEP_DOC BPY_PROPDEF_FLOAT_PREC_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_UNIT_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [7/12]

PyDoc_STRVAR ( BPy_IntProperty_doc  ,
".. function:: IntProperty(name=\"\", " "description=\"\", " "default=0, " "min=-2**31, max=2**31-1, " "soft_min=-2**31, soft_max=2**31-1, " "step=1, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new int property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_NUM_MIN_DOC " :type min: int\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: int\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_min: int\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_max: int\n" BPY_PROPDEF_INT_STEP_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [8/12]

PyDoc_STRVAR ( BPy_IntVectorProperty_doc  ,
".. function:: IntVectorProperty(name=\"\", " "description=\"\", " "default=(0, 0, 0), min=-2**31, max=2**31-1, " "soft_min=-2**31, " "soft_max=2**31-1, " "step=1, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "size=3, " "update=None, " "get=None, " "set=None)\n" "\n" " Returns a new vector int property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: sequence of ints the length of *size*.\n" " :type default: sequence\n" BPY_PROPDEF_NUM_MIN_DOC " :type min: int\n" BPY_PROPDEF_NUM_MAX_DOC " :type max: int\n" BPY_PROPDEF_NUM_SOFTMIN_DOC " :type soft_min: int\n" BPY_PROPDEF_NUM_SOFTMAX_DOC " :type soft_max: int\n" BPY_PROPDEF_INT_STEP_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_NUMBER_ARRAY_DOC BPY_PROPDEF_VECSIZE_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC  BPY_PROPDEF_SET_DOC 
)

◆ PyDoc_STRVAR() [9/12]

PyDoc_STRVAR ( BPy_PointerProperty_doc  ,
".. function:: PointerProperty(type=None, " "name=\"\", " "description=\"\", " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "poll=None, " "update=None)\n" "\n" " Returns a new pointer property definition.\n" "\n" BPY_PROPDEF_POINTER_TYPE_DOC BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_POLL_DOC  BPY_PROPDEF_UPDATE_DOC 
)

◆ PyDoc_STRVAR() [10/12]

PyDoc_STRVAR ( bpy_prop_deferred_doc  ,
"Intermediate storage for properties before registration.\n" "\n" ".. note::\n" "\n" " This is not part of the stable API and may change between releases."   
)

◆ PyDoc_STRVAR() [11/12]

PyDoc_STRVAR ( BPy_RemoveProperty_doc  ,
".. function:: RemoveProperty(cls, attr)\n" "\n" " Removes a dynamically defined property.\n" "\n" " :arg cls: The class containing the property (must be a positional argument).\n" " :type cls: type\n" " :arg attr: Property name (must be passed as a keyword).\n" " :type attr: string\n" "\n" ".. note:: Typically this function doesn't need to be accessed directly.\n" " Instead use ``del cls.attr``\n"   
)

◆ PyDoc_STRVAR() [12/12]

PyDoc_STRVAR ( BPy_StringProperty_doc  ,
".. function:: StringProperty(name=\"\", " "description=\"\", " "default=\"\", " "maxlen=0, " "options={'ANIMATABLE'}, " "override=set(), " "tags=set(), " "subtype='NONE', " "update=None, " "get=None, " "set=None, " "search=None, " "search_options={'SUGGESTION'})\n" "\n" " Returns a new string property definition.\n" "\n" BPY_PROPDEF_NAME_DOC BPY_PROPDEF_DESC_DOC " :arg default: initializer string.\n" " :type default: string\n" " :arg maxlen: maximum length of the string.\n" " :type maxlen: int\n" BPY_PROPDEF_OPTIONS_DOC BPY_PROPDEF_OPTIONS_OVERRIDE_DOC BPY_PROPDEF_TAGS_DOC BPY_PROPDEF_SUBTYPE_STRING_DOC BPY_PROPDEF_UPDATE_DOC BPY_PROPDEF_GET_DOC BPY_PROPDEF_SET_DOC  BPY_PROPDEF_SEARCH_DOC 
)

◆ pyrna_struct_as_instance()

static PyObject* pyrna_struct_as_instance ( PointerRNA ptr)
static

Variable Documentation

◆ bpy_prop_deferred_getset

PyGetSetDef bpy_prop_deferred_getset[]
static
Initial value:
= {
{"function", (getter)bpy_prop_deferred_function_get, (setter)NULL, NULL, NULL},
{"keywords", (getter)bpy_prop_deferred_keywords_get, (setter)NULL, NULL, NULL},
}
static PyObject * bpy_prop_deferred_function_get(BPy_PropDeferred *self, void *UNUSED(closure))
Definition: bpy_props.c:250
static PyObject * bpy_prop_deferred_keywords_get(BPy_PropDeferred *self, void *UNUSED(closure))
Definition: bpy_props.c:261

Definition at line 268 of file bpy_props.c.

◆ bpy_prop_deferred_Type

PyTypeObject bpy_prop_deferred_Type
Initial value:
= {
PyVarObject_HEAD_INIT(NULL, 0)
.tp_name = "_PropertyDeferred",
.tp_basicsize = sizeof(BPy_PropDeferred),
.tp_dealloc = (destructor)bpy_prop_deferred_dealloc,
.tp_repr = (reprfunc)bpy_prop_deferred_repr,
.tp_call = (ternaryfunc)bpy_prop_deferred_call,
.tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC,
.tp_doc = bpy_prop_deferred_doc,
.tp_traverse = (traverseproc)bpy_prop_deferred_traverse,
.tp_clear = (inquiry)bpy_prop_deferred_clear,
}
static PyGetSetDef bpy_prop_deferred_getset[]
Definition: bpy_props.c:268
static int bpy_prop_deferred_clear(BPy_PropDeferred *self)
Definition: bpy_props.c:219
static void bpy_prop_deferred_dealloc(BPy_PropDeferred *self)
Definition: bpy_props.c:206
static int bpy_prop_deferred_traverse(BPy_PropDeferred *self, visitproc visit, void *arg)
Definition: bpy_props.c:213
static PyObject * bpy_prop_deferred_call(BPy_PropDeferred *UNUSED(self), PyObject *UNUSED(args), PyObject *UNUSED(kw))
Definition: bpy_props.c:236
static PyObject * bpy_prop_deferred_repr(BPy_PropDeferred *self)
Definition: bpy_props.c:225

Definition at line 281 of file bpy_props.c.

Referenced by bpy_prop_deferred_data_CreatePyObject(), and BPY_rna_props().

◆ g_bpy_prop_store_list

ListBase g_bpy_prop_store_list = {NULL, NULL}
static

Maintain a list of Python defined properties, so the GC can visit them, and so they can be cleared on exit.

Definition at line 166 of file bpy_props.c.

Referenced by bpy_prop_py_data_ensure(), bpy_prop_py_data_remove(), BPY_rna_props_clear_all(), props_clear(), and props_visit().

◆ props_methods

struct PyMethodDef props_methods[]
static

Definition at line 4496 of file bpy_props.c.

◆ props_module

struct PyModuleDef props_module
static
Initial value:
= {
PyModuleDef_HEAD_INIT,
"bpy.props",
"This module defines properties to extend Blender's internal data. The result of these "
"functions"
" is used to assign properties to classes registered with Blender and can't be used "
"directly.\n"
"\n"
".. note:: All parameters to these functions must be passed as keywords.\n",
-1,
}
static int props_visit(PyObject *UNUSED(self), visitproc visit, void *arg)
Definition: bpy_props.c:4601
static int props_clear(PyObject *UNUSED(self))
Definition: bpy_props.c:4612
static struct PyMethodDef props_methods[]
Definition: bpy_props.c:4552

Definition at line 4612 of file bpy_props.c.

Referenced by BPY_rna_props().

◆ pymeth_BoolProperty

PyObject* pymeth_BoolProperty = NULL
static

Definition at line 321 of file bpy_props.c.

Referenced by BPy_BoolProperty().

◆ pymeth_BoolVectorProperty

PyObject* pymeth_BoolVectorProperty = NULL
static

Definition at line 322 of file bpy_props.c.

Referenced by BPy_BoolVectorProperty().

◆ pymeth_CollectionProperty

PyObject* pymeth_CollectionProperty = NULL
static

Definition at line 330 of file bpy_props.c.

Referenced by BPy_CollectionProperty().

◆ pymeth_EnumProperty

PyObject* pymeth_EnumProperty = NULL
static

Definition at line 328 of file bpy_props.c.

Referenced by BPy_EnumProperty().

◆ pymeth_FloatProperty

PyObject* pymeth_FloatProperty = NULL
static

Definition at line 325 of file bpy_props.c.

Referenced by BPy_FloatProperty().

◆ pymeth_FloatVectorProperty

PyObject* pymeth_FloatVectorProperty = NULL
static

Definition at line 326 of file bpy_props.c.

Referenced by BPy_FloatVectorProperty().

◆ pymeth_IntProperty

PyObject* pymeth_IntProperty = NULL
static

Definition at line 323 of file bpy_props.c.

Referenced by BPy_IntProperty().

◆ pymeth_IntVectorProperty

PyObject* pymeth_IntVectorProperty = NULL
static

Definition at line 324 of file bpy_props.c.

Referenced by BPy_IntVectorProperty().

◆ pymeth_PointerProperty

PyObject* pymeth_PointerProperty = NULL
static

Definition at line 329 of file bpy_props.c.

Referenced by BPy_PointerProperty().

◆ pymeth_RemoveProperty

PyObject* pymeth_RemoveProperty = NULL
static

Definition at line 331 of file bpy_props.c.

◆ pymeth_StringProperty

PyObject* pymeth_StringProperty = NULL
static

Definition at line 327 of file bpy_props.c.

Referenced by BPy_StringProperty().