1berry/blender
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Fix T63651: ImagePreviewCollection.new,load don't work as documented

Browse Source 
Update doc-strings, add note for why this decision was made.
This commit is contained in:
Campbell Barton 2020-09-17 12:42:07 +10:00
parent 70eb24a575
commit 971fe43d06
2 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
release/scripts/modules/bpy/utils/previews.py
View File

@ -65,6 +65,10 @@ class ImagePreviewCollection(dict):
# Internal notes:
# - Blender's internal 'PreviewImage' struct uses 'self._uuid' prefix.
# - Blender's preview.new/load return the data if it exists,
# don't do this for the Python API as it allows accidental re-use of names,
# anyone who wants to reuse names can use dict.get() to check if it exists.
# We could use this for the C API too (would need some investigation).
def __init__(self):
super().__init__()

29
source/blender/python/intern/bpy_utils_previews.c
View File

@ -49,15 +49,20 @@
#define STR_SOURCE_TYPES "'IMAGE', 'MOVIE', 'BLEND', 'FONT'"
PyDoc_STRVAR(bpy_utils_previews_new_doc,
".. method:: new(name)\n"
"\n"
" Generate a new empty preview, or return existing one matching ``name``.\n"
"\n"
" :arg name: The name (unique id) identifying the preview.\n"
" :type name: string\n"
" :return: The Preview matching given name, or a new empty one.\n"
" :rtype: :class:`bpy.types.ImagePreview`\n");
PyDoc_STRVAR(
bpy_utils_previews_new_doc,
".. method:: new(name)\n"
"\n"
" Generate a new empty preview.\n"
"\n"
/* This is only true when accessed via 'bpy.utils.previews.ImagePreviewCollection.new',
* however this is the public API, allow this minor difference to the internal version here. */
" If ``name`` already exists a KeyError exception is raised.\n"
"\n"
" :arg name: The name (unique id) identifying the preview.\n"
" :type name: string\n"
" :return: The Preview matching given name, or a new empty one.\n"
" :rtype: :class:`bpy.types.ImagePreview`\n");
static PyObject *bpy_utils_previews_new(PyObject *UNUSED(self), PyObject *args)
{
char *name;
@ -78,7 +83,11 @@ PyDoc_STRVAR(
bpy_utils_previews_load_doc,
".. method:: load(name, filepath, filetype, force_reload=False)\n"
"\n"
" Generate a new preview from given file path, or return existing one matching ``name``.\n"
" Generate a new preview from given file path.\n"
"\n"
/* This is only true when accessed via 'bpy.utils.previews.ImagePreviewCollection.load',
* however this is the public API, allow this minor difference to the internal version here. */
" If ``name`` already exists a KeyError exception is raised.\n"
"\n"
" :arg name: The name (unique id) identifying the preview.\n"
" :type name: string\n"