Changes to a PropertyGroup in the preferences of an addon do not trigger the flag indicating changes to save #71593

New Issue

Robert Moats · 2019-11-15T00:57:21+01:00

Robert Moats commented

2019-11-15 00:57:21 +01:00

System Information
Operating system: Windows-10-10.0.17763 64 Bits
Graphics card: GeForce GTX 1080/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 418.81

Blender Version
Broken: version: 2.80 (sub 74), branch: master, commit date: 2019-07-11 13:50, hash: 06312c6d2d
Worked: (optional)

Short description of error
User preferences and add-on preferences are normally auto-saved when Blender exits, and it is triggered when the user modifies preferences data through the UI.
But there appears to be a bug that prevents this from happening when the preference data is defined inside of a property group.
2020-01-08 16-39-50.mp4

Exact steps for others to reproduce the error

Install the simplified addon attached - (simple script that adds/draws two preference variables for an add-on: One directly inside of a class derived from bpy.types.AddonPreferences, and one inside of a class derived from bpy.types.PropertyGroup)
In the addon UI, modify any the group preferences - (neither value will be saved on exit)
In the addon UI, modify the root preference - (dirty flag or auto-save will be triggered)
A similar issue occurs when preference values are programmatically altered (auto-save is not triggered), but I'm not sure if this is a bug, or lack of a feature.
user_pref_addon.py

**System Information** Operating system: Windows-10-10.0.17763 64 Bits Graphics card: GeForce GTX 1080/PCIe/SSE2 NVIDIA Corporation 4.5.0 NVIDIA 418.81 **Blender Version** Broken: version: 2.80 (sub 74), branch: master, commit date: 2019-07-11 13:50, hash: `06312c6d2d` Worked: (optional) **Short description of error** User preferences and add-on preferences are normally auto-saved when Blender exits, and it is triggered when the user modifies preferences data through the UI. But there appears to be a bug that prevents this from happening when the preference data is defined inside of a property group. [2020-01-08 16-39-50.mp4](https://archive.blender.org/developer/F8266158/2020-01-08_16-39-50.mp4) **Exact steps for others to reproduce the error** - Install the simplified addon attached - (simple script that adds/draws two preference variables for an add-on: One directly inside of a class derived from `bpy.types.AddonPreferences`, and one inside of a class derived from `bpy.types.PropertyGroup`) - In the addon UI, modify any the group preferences - (neither value will be saved on exit) - In the addon UI, modify the root preference - (dirty flag or auto-save will be triggered) A similar issue occurs when preference values are programmatically altered (auto-save is not triggered), but I'm not sure if this is a bug, or lack of a feature. [user_pref_addon.py](https://archive.blender.org/developer/F8266157/user_pref_addon.py)

Robert Moats commented

2019-11-15 00:57:21 +01:00

Added subscriber: @CodeRunner

blender-admin commented

2019-11-15 00:57:21 +01:00

#86964 was marked as duplicate of this issue

blender-admin commented

2019-11-15 00:57:21 +01:00

blender/blender-addons#81165 was marked as duplicate of this issue

blender-admin commented

2019-11-15 00:57:21 +01:00

#66303 was marked as duplicate of this issue

Germano Cavalcante commented

2019-11-20 19:49:21 +01:00

Added subscriber: @mano-wii

Germano Cavalcante commented

2019-11-20 19:49:21 +01:00

It is probably related to the problem described in #66303
Could you provide a blend file or script demonstrating the problem?

It is probably related to the problem described in #66303 Could you provide a blend file or script demonstrating the problem?

Robert Moats commented

2019-11-22 15:46:10 +01:00

I'm very new to Python and Blender development, so I'm probably not the best person to throw one together. But it should be simple to do so for someone who knows what they're doing. It would be even easier to modify a copy of an existing add-on, which would only involve moving some preferences properties from the primary preferences structure to a child property group derived class. There may even already be some add-ons setup this way - I will try to find one. If needed, I can try to throw something together, or make a slight modification to one of the built-in add-ons.

Jacques Lucke commented

2020-01-08 16:41:08 +01:00

Added subscriber: @JacquesLucke

Jacques Lucke commented

2020-01-08 16:41:08 +01:00

Changed status from 'Needs Triage' to: 'Confirmed'

Jacques Lucke commented

2020-01-08 16:41:08 +01:00

I can reproduce the issue with the following small addon.

user_pref_addon.py

2020-01-08 16-39-50.mp4

@mano-wii good catch that this is probably the same issue. Will merge them.

I can reproduce the issue with the following small addon. [user_pref_addon.py](https://archive.blender.org/developer/F8266157/user_pref_addon.py) [2020-01-08 16-39-50.mp4](https://archive.blender.org/developer/F8266158/2020-01-08_16-39-50.mp4) @mano-wii good catch that this is probably the same issue. Will merge them.

Jacques Lucke commented

2020-01-08 16:41:30 +01:00

Added subscribers: @GavinScott, @ZedDB, @brecht

Campbell Barton commented

2020-09-26 06:05:49 +02:00

Added subscriber: @funksy

Chris Kohl commented

2020-12-28 03:57:07 +01:00

Added subscriber: @ckohl_art

Germano Cavalcante changed title from ~~Preferences Modification Auto-Save Bug~~ to Changes to a PropertyGroup in the preferences of an addon do not trigger save

2021-03-30 20:34:42 +02:00

Germano Cavalcante commented

2021-03-30 20:38:59 +02:00

Added subscribers: @Sergey, @JulianEisel

Germano Cavalcante changed title from ~~Changes to a PropertyGroup in the preferences of an addon do not trigger save~~ to Changes to a PropertyGroup in the preferences of an addon do not trigger the flag indicating changes to save

2021-03-30 20:41:09 +02:00

Julian Eisel commented

2021-04-13 14:39:37 +02:00

Problem is that this function doesn't cover this case: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/interface/interface_handlers.c$622-640.
Ideally this could just walk up the RNA path of the property to see if any parent is of a preferences RNA type. But we can't get that path there unfortunately, not sure if there's a way to get it.
Alternatively, when registering custom properties, BPY could flag them as "inside a preferences struct". But this would break when nesting a property group inside a property group inside the add-on preferences...

This works, and although a bit odd at first, it does make sense to do this on second thought - at least to me:

@@ -10,3 +10,3 @@ from bpy.props import *
 
-class TestPropertyGroup(bpy.types.PropertyGroup):
+class TestPropertyGroup(bpy.types.PropertyGroup, bpy.types.AddonPreferences):
     prop2: IntProperty(name="Prop 2")

Problem is that this function doesn't cover this case: https://developer.blender.org/diffusion/B/browse/master/source/blender/editors/interface/interface_handlers.c$622-640. Ideally this could just walk up the RNA path of the property to see if any parent is of a preferences RNA type. But we can't get that path there unfortunately, not sure if there's a way to get it. Alternatively, when registering custom properties, BPY could flag them as "inside a preferences struct". But this would break when nesting a property group inside a property group inside the add-on preferences... This works, and although a bit odd at first, it does make sense to do this on second thought - at least to me: ``` @@ -10,3 +10,3 @@ from bpy.props import * -class TestPropertyGroup(bpy.types.PropertyGroup): +class TestPropertyGroup(bpy.types.PropertyGroup, bpy.types.AddonPreferences): prop2: IntProperty(name="Prop 2") ```

Moritz Brückner commented

2021-05-30 15:44:48 +02:00

Added subscriber: @timodriaan

Philipp Oeser removed the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Changes to a PropertyGroup in the preferences of an addon do not trigger the flag indicating changes to save #71593