Fix #113255: LineStyle modifiers cannot be accessed by name anymore #113290

Philipp Oeser · 2023-10-05T14:45:15+02:00

Philipp Oeser commented

2023-10-05 14:45:15 +02:00

Caused by 6a49041be3 .

Above commit checks an existing nameproperty for collection items, but
it does so in a way that it only checks the "parent" type. If these are
"subclassed" though, we might not have the nameproperty defined on the
"parent" class (but on the subclass instead).
Code would then error out with e.g. "FreestyleLineStyle.color_modifiers
does not support string lookups".

In the case of the report the following happened.

linestyle modifiers (LineStyleModifier) can be any of:
-- color_modifiers / LineStyleColorModifier
-- alpha_modifiers / LineStyleAlphaModifier
-- thickness_modifiers / LineStyleThicknessModifier
-- geometry_modifiers / LineStyleGeometryModifier

But all of the above have subtypes, e.g.
LineStyleColorModifier_AlongStroke,
LineStyleColorModifier_DistanceFromCamera, ...
Currently, the nameproperty is not defined e.g. on the
LineStyleColorModifier (but instead on the subtypes).

Prior to 6a49041be3 (without
RNA_property_collection_lookup_string_has_nameprop in place),
pyrna_prop_collection_subscript_str could still actually find the
nameprop because it iterates into the collection and got it on the
actual Item (LineStyleColorModifier_DistanceFromCamera instead of
LineStyleColorModifier).

So while it might be possible to refine
RNA_property_collection_lookup_string_has_nameprop to descend into
subclasses (I didnt find an obvious way though other than scanning all
existing modifiers [not modifier types -- we would need a way to find
all types that inherit from e.g. LineStyleColorModifier] which kind of
defeats the purpose of checking this early), this PR moves the name
definition from the subclass to the parent class (so way from
rna_def_modifier_type_common) -- and this way,
RNA_property_collection_lookup_string_has_nameprop can properly pick
up the nameprop. It does a bit of code duplication though.

Caused by 6a49041be3d5 . Above commit checks an existing nameproperty for collection items, but it does so in a way that it only checks the "parent" type. If these are "subclassed" though, we might not have the nameproperty defined on the "parent" class (but on the subclass instead). Code would then error out with e.g. "FreestyleLineStyle.color_modifiers does not support string lookups". In the case of the report the following happened. - linestyle modifiers (`LineStyleModifier`) can be any of: -- `color_modifiers` / `LineStyleColorModifier` -- `alpha_modifiers` / `LineStyleAlphaModifier` -- `thickness_modifiers` / `LineStyleThicknessModifier` -- `geometry_modifiers` / `LineStyleGeometryModifier` But all of the above have subtypes, e.g. `LineStyleColorModifier_AlongStroke`, `LineStyleColorModifier_DistanceFromCamera`, ... Currently, the `nameproperty` is not defined e.g. on the `LineStyleColorModifier` (but instead on the subtypes). Prior to 6a49041be3d5 (without `RNA_property_collection_lookup_string_has_nameprop` in place), `pyrna_prop_collection_subscript_str` could still actually find the nameprop because it iterates into the collection and got it on the actual Item (`LineStyleColorModifier_DistanceFromCamera` instead of `LineStyleColorModifier`). So while it might be possible to refine `RNA_property_collection_lookup_string_has_nameprop` to descend into subclasses (I didnt find an obvious way though other than scanning all existing modifiers [not modifier types -- we would need a way to find all types that inherit from e.g. `LineStyleColorModifier`] which kind of defeats the purpose of checking this early), this PR moves the name definition from the subclass to the parent class (so way from `rna_def_modifier_type_common`) -- and this way, `RNA_property_collection_lookup_string_has_nameprop` can properly pick up the nameprop. It does a bit of code duplication though.

Philipp Oeser added 1 commit 2023-10-05 14:45:28 +02:00

89d0969125 Fix #113255 : LineStyle modifiers cannot be accessed by name anymore

Caused by 6a49041be3 .

Above commit checks an existing nameproperty for collection items, but
it does so in a way that it only checks the "parent" type. If these are
"subclassed" though, we might not have the nameproperty defined on the
"parent" class (but on the subclass instead).
Code would then error out with e.g. "FreestyleLineStyle.color_modifiers
does not support string lookups".

In the case of the report the following happened.

- linestyle modifiers (`LineStyleModifier`) can be any of:
-- `color_modifiers` / `LineStyleColorModifier`
-- `alpha_modifiers` / `LineStyleAlphaModifier`
-- `thickness_modifiers` / `LineStyleThicknessModifier`
-- `geometry_modifiers` / `LineStyleGeometryModifier`

But all of the above have subtypes, e.g.
`LineStyleColorModifier_AlongStroke`,
`LineStyleColorModifier_DistanceFromCamera`, ...
Currently, the `nameproperty` is not defined e.g. on the
`LineStyleColorModifier` (but instead on the subtypes).

Prior to 6a49041be3 (without
`RNA_property_collection_lookup_string_has_nameprop` in place),
`pyrna_prop_collection_subscript_str` could still actually find the
nameprop because it iterates into the collection and got it on the
actual Item (`LineStyleColorModifier_DistanceFromCamera` instead of
`LineStyleColorModifier`).

So while it might be possible to refine
`RNA_property_collection_lookup_string_has_nameprop` to descend into
subclasses (I didnt find an obvious way though other than scanning all
existing modifiers [not modifier types -- we would need a way to find
all types that inherit from e.g. `LineStyleColorModifier`] which kind of
defeats the purpose of checking this early), this PR moves the name
definition from the subclass to the parent class (so way from
`rna_def_modifier_type_common`) -- and this way,
`RNA_property_collection_lookup_string_has_nameprop` can properly pick
up the nameprop. It does a bit of code duplication though.

Philipp Oeser requested review from Campbell Barton 2023-10-05 14:45:42 +02:00

Philipp Oeser added this to the Core project 2023-10-05 14:46:33 +02:00

Philipp Oeser added the

Download

What's New

Blender Studio

Manual

Developers Blog

Documentation

Benchmark

Blender Conference

Development Fund

One-time Donations

Fix #113255: LineStyle modifiers cannot be accessed by name anymore #113290