Details

Reviewers

Bastien Montagne (mont29)
Sybren A. Stüvel (sybren)

Summary

This adds support for creating a BlendFile (internally called Main),
which is limited to a context.

This can now be passed to bpy.data.libraries.load, supporting loading temporary data.

To prevent errors caused by mixing the temporary ID's with data in bpy.data
they are tagged as temporary so they can't be assigned to properties,
however they can be passed as arguments to functions.

This adds id_tag_extra to support adding extra ID tags at load time. This will be split off into a separate commit.

This is one of the requirements for T86183: Pose Library: temporarily load Action asset.

Example usage:

P2011 D10612_example.py

1	import bpy
2	lib = "/path/to/file.blend"
3	with bpy.types.BlendData.temp_data() as temp_data:
4	with temp_data.libraries.load(lib) as (data_from, data_to):
5	data_to.objects = data_from.objects
6	print(data_from.objects)
7	print(temp_data.objects[:])
8
9	# This would raise an error, good!
10	# "TypeError: bpy_struct: item.attr = val: Object.parent ID type assignment is temporary, can't assign"
11	# bpy.data.objects[0].parent = temp_data.objects[0]
12
13	# This would raise an error, also good!
14	# "ReferenceError: StructRNA of type BlendData has been removed"
15	# print(temp_data.objects[:])

Diff Detail

Repository

rB Blender

Branch

TEMP-DATA-API (branched from master)

Build Status

Buildable 13249
Build 13249: arc lint + arc unit

Event Timeline

Campbell Barton (campbellbarton) requested review of this revision.Mar 4 2021, 8:12 AM

Campbell Barton (campbellbarton) created this revision.

Harbormaster completed remote builds in B13246: Diff 34746.Mar 4 2021, 8:12 AM

Correct docstrings

Harbormaster completed remote builds in B13247: Diff 34747.Mar 4 2021, 8:31 AM

Campbell Barton (campbellbarton) retitled this revision from Python API for temporary library loading to PyAPI: add bpy.types.BlendFile.temp_data for temporary library loading.Mar 4 2021, 8:38 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Mar 4 2021, 8:41 AM

Campbell Barton (campbellbarton) added reviewers: Bastien Montagne (mont29), Sybren A. Stüvel (sybren).

Campbell Barton (campbellbarton) added projects: Core, Python API.

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Mar 4 2021, 9:56 AM

Campbell Barton (campbellbarton) planned changes to this revision.Mar 4 2021, 10:06 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Mar 4 2021, 11:19 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)

LGTM except for one little thing.

source/blender/python/intern/bpy_library_load.c
229	Doesn't this violate the "Only set when this doesn't match #G_MAIN" comment in the `BPy_Library` struct? It's probably more correct to swap this line with the next and do `ret->bmain = ret->bmain_is_temp ? bmain : NULL`. On the other hand, that would require adding `NULL`-checks in other areas of the code. Maybe it's better to update the comment itself then, to read something like: `Set to #G_MAIN when bmain_is_temp=false, or to the temporary main when bmain_is_temp=true`

Correct comment

Harbormaster completed remote builds in B13249: Diff 34754.Mar 4 2021, 11:49 AM

Campbell Barton (campbellbarton) marked an inline comment as done.Mar 4 2021, 11:50 AM

Sybren A. Stüvel (sybren) accepted this revision.Mar 4 2021, 11:52 AM

This revision is now accepted and ready to land.Mar 4 2021, 11:52 AM

Added regular method support to RNA collections (in master rBd9e567d36573: PyAPI: support methods for collection properties).

Use methods to avoid passing the BlendData as an argument to 'load'.

with bpy.types.BlendData.temp_data() as temp_data:
    with bpy.data.libraries.load(lib, data=temp_data) as (data_from, data_to)

Is now written as:

with bpy.types.BlendData.temp_data() as temp_data:
    with temp_data.libraries.load(lib) as (data_from, data_to)

Harbormaster completed remote builds in B13250: Diff 34755.Mar 4 2021, 1:22 PM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Mar 4 2021, 1:23 PM

Bastien Montagne (mont29) requested changes to this revision.Mar 4 2021, 2:28 PM

Bastien Montagne (mont29) added inline comments.

source/blender/python/intern/bpy_library_load.c
388–389	I think the code behind this code (in `readfile.c`) needs to be updated to ensure no session uuid is generated (and global counter is not increased) when `bmain_is_temp` is `True`?

This revision now requires changes to proceed.Mar 4 2021, 2:28 PM

Sybren A. Stüvel (sybren) mentioned this in T86270: Asset Browser: add more info about selected asset to context.Mar 4 2021, 3:01 PM

Sybren A. Stüvel (sybren) added a project: Asset Browser (Archived) (Pose Library Basics).Mar 4 2021, 3:26 PM

Add a generic way to set the TAG flag when loading ID's.
Don't set session UUID for temporary ID's

Harbormaster completed remote builds in B13293: Diff 34836.Mar 6 2021, 11:03 AM

Campbell Barton (campbellbarton) marked an inline comment as done.Mar 6 2021, 11:05 AM

Add assert if any *unsafe* tags are set as extra tags.

Harbormaster completed remote builds in B13294: Diff 34837.Mar 6 2021, 11:09 AM

Campbell Barton (campbellbarton) edited the summary of this revision. (Show Details)Mar 7 2021, 5:55 AM

Add comment explaining why LibraryLink_Params.id_tag_extra is duplicated in FileData.

Harbormaster completed remote builds in B13297: Diff 34841.Mar 7 2021, 7:06 AM

Sybren A. Stüvel (sybren) accepted this revision.Mar 8 2021, 11:50 AM

Bastien Montagne (mont29) requested changes to this revision.Mar 8 2021, 12:33 PM

Bastien Montagne (mont29) added inline comments.

source/blender/blenloader/intern/readfile.c
2427–2429 ↗	(On Diff #34841)	Think this is also needed in `create_placeholder` ? Loading IDs from a lib, even temporarily, may also imply loading IDs from other libs, which could be missing too.

This revision now requires changes to proceed.Mar 8 2021, 12:33 PM

Disable setting the UUID for create_placeholder() & in versioning code, also add assert to ensure this never happens.

Harbormaster completed remote builds in B13324: Diff 34877.Mar 8 2021, 1:23 PM

LGTM now :)

This revision is now accepted and ready to land.Mar 8 2021, 2:02 PM

Campbell Barton (campbellbarton) mentioned this in rBcfd11af98194: readfile: add id_tag_extra argument.Mar 8 2021, 3:05 PM

Campbell Barton (campbellbarton) mentioned this in rB9e0921497912: PyAPI: add bpy.types.BlendFile.temp_data for temporary library loading.

committed rB9e0921497912cbfe9846358d1cb1220f88315f80, rBcfd11af9819433c5b83359b72f002fcd59fdc1ab

PyAPI: add bpy.types.BlendFile.temp_data for temporary library loading
ClosedPublic
Actions

Details

Other Topics

Diff Detail

Event Timeline

Revision Contents
Changeset List

Diff 34754

doc/python_api/examples/bpy.types.BlendDataLibraries.load.py

source/blender/makesdna/DNA_ID.h

source/blender/python/intern/CMakeLists.txt

source/blender/python/intern/bpy.c

source/blender/python/intern/bpy_library_load.c

source/blender/python/intern/bpy_rna.c

source/blender/python/intern/bpy_rna_data.h

source/blender/python/intern/bpy_rna_data.c

source/blender/python/intern/bpy_rna_types_capi.c

PyAPI: add bpy.types.BlendFile.temp_data for temporary library loadingClosedPublicActions

Details

Other Topics

Diff Detail

Event Timeline

Revision ContentsChangeset List

Diff 34754

doc/python_api/examples/bpy.types.BlendDataLibraries.load.py

source/blender/makesdna/DNA_ID.h

source/blender/python/intern/CMakeLists.txt

source/blender/python/intern/bpy.c

source/blender/python/intern/bpy_library_load.c

source/blender/python/intern/bpy_rna.c

source/blender/python/intern/bpy_rna_data.h

source/blender/python/intern/bpy_rna_data.c

source/blender/python/intern/bpy_rna_types_capi.c

PyAPI: add bpy.types.BlendFile.temp_data for temporary library loading
ClosedPublic
Actions

Revision Contents
Changeset List