Fix #102885: IDproperty subtype can cause Blender UI to throw exception #112582

Jorijn de Graaf · 2023-09-19T16:03:28+02:00

Jorijn de Graaf commented

2023-09-19 16:03:28 +02:00

When the subtype of a custom property is set programmatically to something that isn't in the subtype enum of this operator, attempting to edit it will throw an error.
This check should avoid that, by simply not setting the subtype if it's not in the enum, resulting in a default subtype of NONE.
It would also be good to add some more subtypes for float array, but I'll do that in a separate PR.

When the subtype of a custom property is set programmatically to something that isn't in the subtype enum of this operator, attempting to edit it will throw an error. This check should avoid that, by simply not setting the subtype if it's not in the enum, resulting in a default subtype of NONE. It would also be good to add some more subtypes for float array, but I'll do that in a separate PR.

Jorijn de Graaf added 1 commit 2023-09-19 16:03:42 +02:00

a9c04195c1 Check whether custom property subtype is valid

When the subtype of a custom property is set programmatically to something that isn't in the subtype enum of this operator, attempting to edit it will throw an error.
This check should avoid that, by simply not setting the subtype if it's not in the enum, resulting in a default subtype of NONE.

Jorijn de Graaf requested review from Hans Goudey 2023-09-19 16:07:19 +02:00

Jorijn de Graaf requested review from Campbell Barton 2023-09-19 16:07:24 +02:00

Jorijn de Graaf commented

2023-09-19 16:14:53 +02:00

Here is the PR that adds more subtypes for float array: #112583

Here is the PR that adds more subtypes for float array: https://projects.blender.org/blender/blender/pulls/112583

Germano Cavalcante commented

2023-09-20 14:50:44 +02:00

I'm not really up on the details. Is the subtype supported?

I feel like it would be better to somehow throw an error message the moment an invalid subtype is set instead of silently changing/hiding some setting when editing the property.

I'm not really up on the details. Is the subtype supported? I feel like it would be better to somehow throw an error message the moment an invalid subtype is set instead of silently changing/hiding some setting when editing the property.

Jorijn de Graaf commented

2023-09-20 15:21:24 +02:00

Blender is fine with any subtype for any property, but not all of them make sense to use.
If a subtype doesn't make sense to use (for example PASSWORD for a float property), it behaves the same way as subtype NONE.
Currently the issue with this operator is that it only exposes a small number of subtypes to the user, and attempting to edit a property that has a subtype not in its list, results in an error.
This error isn't intentional, but result of an oversight, and prevents you from editing the property.

My solution comes in two parts: a different PR which adds more subtypes to this operator, and this PR which fixes the error when a subtype isn't in the list.
Without the error, you are able to set the subtype to any in the list, or cancel and leave it as-is.
I suppose an alternative solution would be to show all subtypes in the list, but it wouldn't be the best user experience.

Blender is fine with any subtype for any property, but not all of them make sense to use. If a subtype doesn't make sense to use (for example PASSWORD for a float property), it behaves the same way as subtype NONE. Currently the issue with this operator is that it only exposes a small number of subtypes to the user, and attempting to edit a property that has a subtype not in its list, results in an error. This error isn't intentional, but result of an oversight, and prevents you from editing the property. My solution comes in two parts: a different PR which adds more subtypes to this operator, and this PR which fixes the error when a subtype isn't in the list. Without the error, you are able to set the subtype to any in the list, or cancel and leave it as-is. I suppose an alternative solution would be to show all subtypes in the list, but it wouldn't be the best user experience.

Hans Goudey approved these changes 2023-09-26 19:47:48 +02:00

Jorijn de Graaf commented

2023-10-19 23:07:19 +02:00

Is there anything I need to do here?

Jorijn de Graaf added 1 commit 2023-10-19 23:07:49 +02:00

21336ae243 Merge branch 'main' into fix/custom-property-subtype

Hans Goudey commented

2023-10-19 23:46:39 +02:00

Hmm, sorry I had forgotten about this. The PR should be rebased to the 4.0 branch now though, since that's where bug fixes go at this stage of the release cycle. There's more info about that here: https://wiki.blender.org/wiki/Tools/Pull_Requests

Jorijn de Graaf closed this pull request

2023-10-21 14:52:41 +02:00

Jorijn de Graaf changed title from ~~Fix #102885: IDproperty subtype can cause Blender UI to throw exception~~ to Fix #102885: IDproperty subtype can cause Blender UI to throw exception

2023-10-21 14:55:59 +02:00

Jorijn de Graaf commented

2023-10-21 14:56:20 +02:00

I didn't intend to close it, guess messing with branches locally broke something.

Jorijn de Graaf changed title from ~~Fix #102885: IDproperty subtype can cause Blender UI to throw exception~~ to Fix #102885: IDproperty subtype can cause Blender UI to throw exception

2023-10-21 14:56:40 +02:00

Jorijn de Graaf referenced this pull request

2023-10-21 14:59:51 +02:00

Fix #102885: IDproperty subtype can cause Blender UI to throw exception #114003

Hans Goudey referenced this issue from a commit

2023-10-21 15:03:37 +02:00

Fix #102885: IDproperty subtype can cause Blender UI to throw exception