Fix T44822: python enums' itemf callback did not handle 'NULL' context case.

Enum's itemf callback can be called without context in some cases (UI, doc generation...).
Python's enum properties did not handle this at all - it's kind of odd this did not cause
more trouble and wasn't notice earlier... Probably dynamic enums using context are not
much used in py code.

Note about nodes: those are heavy users of dynamic enum with context. Now,
we expect `NodeCategory.poll()` and `NodeItem.poll()` to always be called with
a valid context (since when there is no context available, we can assume `poll()`
is always True). `NodeCategory.items()`, however, must accept NULL context, so if
you use custom `items` callable for your custom node categories, you may need
to update it (as was done here for builtin `node_group_items()`).
This commit is contained in:
2015-05-25 14:19:51 +02:00
parent 39b85e452f
commit a80c1e50bc
4 changed files with 30 additions and 9 deletions

View File

@@ -37,7 +37,7 @@ class NodeCategory:
else: else:
def items_gen(context): def items_gen(context):
for item in items: for item in items:
if item.poll is None or item.poll(context): if item.poll is None or context is None or item.poll(context):
yield item yield item
self.items = items_gen self.items = items_gen
@@ -136,7 +136,7 @@ def register_node_categories(identifier, cat_list):
def node_categories_iter(context): def node_categories_iter(context):
for cat_type in _node_categories.values(): for cat_type in _node_categories.values():
for cat in cat_type[0]: for cat in cat_type[0]:
if cat.poll and cat.poll(context): if cat.poll and ((context is None) or cat.poll(context)):
yield cat yield cat

View File

@@ -66,6 +66,8 @@ node_tree_group_type = {
# generic node group items generator for shader, compositor and texture node groups # generic node group items generator for shader, compositor and texture node groups
def node_group_items(context): def node_group_items(context):
if context is None:
return
space = context.space_data space = context.space_data
if not space: if not space:
return return

View File

@@ -25,9 +25,12 @@ import bpy
def enum_previews_from_directory_items(self, context): def enum_previews_from_directory_items(self, context):
"""EnumProperty callback""" """EnumProperty callback"""
wm = context.window_manager
enum_items = [] enum_items = []
if context is None:
return enum_items
wm = context.window_manager
directory = wm.my_previews_dir directory = wm.my_previews_dir
# Get the preview collection (defined in register func). # Get the preview collection (defined in register func).

View File

@@ -1481,15 +1481,26 @@ static EnumPropertyItem *bpy_prop_enum_itemf_cb(struct bContext *C, PointerRNA *
EnumPropertyItem *eitems = NULL; EnumPropertyItem *eitems = NULL;
int err = 0; int err = 0;
bpy_context_set(C, &gilstate); if (C) {
bpy_context_set(C, &gilstate);
}
else {
gilstate = PyGILState_Ensure();
}
args = PyTuple_New(2); args = PyTuple_New(2);
self = pyrna_struct_as_instance(ptr); self = pyrna_struct_as_instance(ptr);
PyTuple_SET_ITEM(args, 0, self); PyTuple_SET_ITEM(args, 0, self);
/* now get the context */ /* now get the context */
PyTuple_SET_ITEM(args, 1, (PyObject *)bpy_context_module); if (C) {
Py_INCREF(bpy_context_module); PyTuple_SET_ITEM(args, 1, (PyObject *)bpy_context_module);
Py_INCREF(bpy_context_module);
}
else {
PyTuple_SET_ITEM(args, 1, Py_None);
Py_INCREF(Py_None);
}
items = PyObject_CallObject(py_func, args); items = PyObject_CallObject(py_func, args);
@@ -1530,8 +1541,13 @@ static EnumPropertyItem *bpy_prop_enum_itemf_cb(struct bContext *C, PointerRNA *
eitems = DummyRNA_NULL_items; eitems = DummyRNA_NULL_items;
} }
if (C) {
bpy_context_clear(C, &gilstate);
}
else {
PyGILState_Release(gilstate);
}
bpy_context_clear(C, &gilstate);
return eitems; return eitems;
} }
@@ -2618,7 +2634,7 @@ PyDoc_STRVAR(BPy_EnumProperty_doc,
" Note the item is optional.\n" " Note the item is optional.\n"
" For dynamic values a callback can be passed which returns a list in\n" " For dynamic values a callback can be passed which returns a list in\n"
" the same format as the static list.\n" " the same format as the static list.\n"
" This function must take 2 arguments (self, context)\n" " This function must take 2 arguments (self, context), **context may be None**.\n"
" WARNING: There is a known bug with using a callback,\n" " WARNING: There is a known bug with using a callback,\n"
" Python must keep a reference to the strings returned or Blender will crash.\n" " Python must keep a reference to the strings returned or Blender will crash.\n"
" :type items: sequence of string tuples or a function\n" " :type items: sequence of string tuples or a function\n"