Invalid translation on keys in python API [new object material node names (Principled BSDF, Material Output) are now translated upon creation] #104145

New Issue

Satoshi Yamasaki · 2023-01-26T02:44:21+01:00

Satoshi Yamasaki commented

2023-01-26 02:44:21 +01:00

System Information
Operating system: Windows 10 pro x64
Graphics card: RTX 2060 12GB

Blender Version
Broken: 3.4
Worked: 3.3 (and perhaps before)

behavior changed in 9d732445b9

Short description of error
Addon compatibiliry is broken with Invalid translation on keys in python API

In 3.4 with translated UI, some addons (E.g. Dream Texture) gives errors. for example,

"material.node_tree.links.new(image_texture_node.outputs- [x], material.node_tree.nodes['Principled BSDF'].inputs[0])"
"KeyError: 'bpy_prop_collection[key]: key "Principled BSDF" not found'"

It doesn't be occured without UI translation (using us_en) and 3.3 and before. It's similar issue that has been occured with translated new data name (Add Camera Rig for example), but this issue is occured due to invalid translating key names with the UI translation funciton dynamically.

Exact steps for others to reproduce the error

Open Preferences, go to Interface tab, and change Translation > Language to (let's say) Japanese.
Open Python Console and enter

>>> mat = D.materials.new("Mat")
>>> mat.use_nodes = True
>>> mat.node_tree.nodes["

Press Tab to autocomplete.
Observe node names. Here's a comparison between 3.5 (left) and 3.3.2 (right).

**System Information** Operating system: Windows 10 pro x64 Graphics card: RTX 2060 12GB **Blender Version** Broken: 3.4 Worked: 3.3 (and perhaps before) behavior changed in 9d732445b9 **Short description of error** Addon compatibiliry is broken with Invalid translation on keys in python API In 3.4 with translated UI, some addons (E.g. Dream Texture) gives errors. for example, "material.node_tree.links.new(image_texture_node.outputs- [x], material.node_tree.nodes['Principled BSDF'].inputs[0])" "KeyError: 'bpy_prop_collection[key]: key "Principled BSDF" not found'" It doesn't be occured without UI translation (using us_en) and 3.3 and before. It's similar issue that has been occured with translated new data name (Add Camera Rig for example), but this issue is occured due to invalid translating key names with the UI translation funciton dynamically. **Exact steps for others to reproduce the error** 1. Open Preferences, go to Interface tab, and change Translation > Language to (let's say) Japanese. 2. Open Python Console and enter ``` >>> mat = D.materials.new("Mat") >>> mat.use_nodes = True >>> mat.node_tree.nodes[" ``` 3. Press Tab to autocomplete. 4. Observe node names. Here's a comparison between 3.5 (left) and 3.3.2 (right). ![names.png](https://archive.blender.org/developer/F14199489/names.png)

Satoshi Yamasaki commented

2023-01-26 02:44:22 +01:00

Added subscriber: @SatoshiYamasaki

Bastien Montagne was assigned by Satoshi Yamasaki

2023-01-26 02:48:01 +01:00

Scurest commented

2023-01-26 03:17:54 +01:00

Added subscriber: @scurest

Pratik Borhade commented

2023-01-26 05:07:48 +01:00

Added subscriber: @PratikPB2123

Pratik Borhade commented

2023-01-26 05:07:48 +01:00

Changed status from 'Needs Triage' to: 'Needs User Info'

Pratik Borhade commented

2023-01-26 05:07:48 +01:00

Hi, thanks for the report. Not sure how to verify this issue locally. Can you share exact steps to repro the issue?

Scurest commented

2023-01-26 05:54:53 +01:00

Open Preferences, go to Interface tab, and change Translation > Language to (let's say) Japanese.
Open Python Console and enter

>>> mat = D.materials.new("Mat")
>>> mat.use_nodes = True
>>> mat.node_tree.nodes["

Press Tab to autocomplete.
Observe node names. Here's a comparison between 3.5 (left) and 3.3.2 (right).

1. Open Preferences, go to Interface tab, and change Translation > Language to (let's say) Japanese. 2. Open Python Console and enter ``` >>> mat = D.materials.new("Mat") >>> mat.use_nodes = True >>> mat.node_tree.nodes[" ``` 3. Press Tab to autocomplete. 4. Observe node names. Here's a comparison between 3.5 (left) and 3.3.2 (right). ![names.png](https://archive.blender.org/developer/F14199489/names.png)

Pratik Borhade commented

2023-01-26 10:18:56 +01:00

Changed status from 'Needs User Info' to: 'Confirmed'

Pratik Borhade commented

2023-01-26 10:18:56 +01:00

Thanks @scurest
~~Bisecting.~~
getting build errors on intermediate commits so unable to bisect.

Thanks @scurest ~~Bisecting.~~ getting build errors on intermediate commits so unable to bisect.

Philipp Oeser commented

2023-01-26 12:56:36 +01:00

Added subscribers: @pioverfour, @lichtwerk

Philipp Oeser commented

2023-01-26 12:56:36 +01:00

Changed status from 'Confirmed' to: 'Needs Developer To Reproduce'

Philipp Oeser commented

2023-01-26 12:56:36 +01:00

Hm, so behavior changed in 9d732445b9

It might be expected behavior though, not sure if Addons can rely on such a "hardcoded" name in a translated environment (I would assume though that many do).

That being said, the following works as expected (this could be forwarded to the Addon devs as a fix/workaround @SatoshiYamasaki ):

mat = D.materials.new("Mat")
mat.use_nodes = True
mat.node_tree.nodes[bpy.app.translations.pgettext_iface("Principled BSDF")]

In any case, I am raising priority here to get an answer from @mont29 and @pioverfour .
I am not seeing this mentioned in the release notes https://wiki.blender.org/wiki/Reference/Release_Notes/3.4/Python_API (this should be done as a minimal step I think)

Hm, so behavior changed in 9d732445b9 It might be expected behavior though, not sure if Addons can rely on such a "hardcoded" name in a translated environment (I would assume though that many do). That being said, the following works as expected (this could be forwarded to the Addon devs as a fix/workaround @SatoshiYamasaki ): ``` mat = D.materials.new("Mat") mat.use_nodes = True mat.node_tree.nodes[bpy.app.translations.pgettext_iface("Principled BSDF")] ``` In any case, I am raising priority here to get an answer from @mont29 and @pioverfour . I am not seeing this mentioned in the release notes https://wiki.blender.org/wiki/Reference/Release_Notes/3.4/Python_API (this should be done as a minimal step I think)

Philipp Oeser changed title from ~~Invalid translation on keys in python API~~ to Invalid translation on keys in python API [new object material node names (Principled BSDF, Material Output) are now translated upon creation]

2023-01-26 12:58:11 +01:00

Bastien Montagne was unassigned by Philipp Oeser

2023-01-26 12:58:11 +01:00

Philipp Oeser commented

2023-01-26 12:58:11 +01:00

Added subscriber: @mont29

Satoshi Yamasaki commented

2023-01-26 15:59:41 +01:00

Thank you guys and I'm sorry for missing informations.

@lichtwerk: Thank you the code. But I think this new behaivor causes problems than benefits because I don't believe that most of addon devs think about translated environment.
So, It should be reverted I think.

@pioverfour, @mont29: Do you think about it?

Thank you guys and I'm sorry for missing informations. @lichtwerk: Thank you the code. But I think this new behaivor causes problems than benefits because I don't believe that most of addon devs think about translated environment. So, It should be reverted I think. @pioverfour, @mont29: Do you think about it?

Satoshi Yamasaki commented

2023-01-26 18:05:08 +01:00

Oops...this issue is same as other existing issues, just turn off "New Data" option of translation to solve it.
I apologize about this report...

Oops...this issue is same as other existing issues, just turn off "New Data" option of translation to solve it. I apologize about this report...

Satoshi Yamasaki commented

2023-01-26 18:05:43 +01:00

Changed status from 'Needs Developer To Reproduce' to: 'Resolved'

Satoshi Yamasaki closed this issue

2023-01-26 18:05:43 +01:00

Scurest commented

2023-01-26 18:24:41 +01:00

What issue is this a dupe of?

Iliya Katushenock commented

2023-01-26 18:26:58 +01:00

Added subscriber: @mod_moder

Iliya Katushenock commented

2023-01-26 18:26:58 +01:00

Changed status from 'Resolved' to: 'Needs Developer To Reproduce'

Iliya Katushenock reopened this issue

2023-01-26 18:26:58 +01:00

Iliya Katushenock commented

2023-01-26 18:26:58 +01:00

However, this problem can still be found by someone. It's best to wait for the developer's response.

Damien Picard commented

2023-01-26 19:26:54 +01:00

Hi, I agree with @lichtwerk ’s conclusions, the break should have been documented and I apologize for not doing it. Can the release notes still be edited after the fact?

To me, translating the node names is the correct behaviour, and as noted by @SatoshiYamasaki it can be disabled in the preferences—although the option is not so obvious.
The behaviour is still causing bugs for add-ons using hardcoded names though, and it’s a problem because few devs use a translated UI so they’re not going to catch the bug. I’d say that the best course of action would be to report it directly to the developers of Dream Textures and any other add-on affected, and suggest using the fix provided by Philipp (bpy.app.translations.pgettext_iface("Principled BSDF")). I’ll try to determine if any built-in add-ons are having issues.

@SatoshiYamasaki You mentioned several add-ons were affected besides Dream Textures, do you know which ones?

Hi, I agree with @lichtwerk ’s conclusions, the break should have been documented and I apologize for not doing it. Can the release notes still be edited after the fact? To me, translating the node names is the correct behaviour, and as noted by @SatoshiYamasaki it can be disabled in the preferences—although the option is not so obvious. The behaviour is still causing bugs for add-ons using hardcoded names though, and it’s a problem because few devs use a translated UI so they’re not going to catch the bug. I’d say that the best course of action would be to report it directly to the developers of Dream Textures and any other add-on affected, and suggest using the fix provided by Philipp (`bpy.app.translations.pgettext_iface("Principled BSDF")`). I’ll try to determine if any built-in add-ons are having issues. @SatoshiYamasaki You mentioned several add-ons were affected besides Dream Textures, do you know which ones?

Scurest commented

2023-01-26 19:46:27 +01:00

You can can find some by grepping for Material Output and Principled BSDF in the addons folder. io_mesh_atomic for instance has a bunch (example).

You can can find some by grepping for `Material Output` and `Principled BSDF` in the addons folder. io_mesh_atomic for instance has a bunch ([example](https://github.com/blender/blender-addons/blob/9958ddb879934718cc2b379b556f0bc3b861bee5/io_mesh_atomic/pdb_import.py#L756-L759)).

Satoshi Yamasaki commented

2023-01-26 22:17:47 +01:00

@pioverfour: Thank you and sorry, I don't know any addon affected this change except Dream Texture. it's just my fault.

I agree that this is correct behavior too. I remember Add Camera Rig and some addons (sorry, I forget them) had similar problem for bone constraints or modifiers which added by scripts, but it works fine now. so I believe Dream Texture (and other addons I don't know) will be fixed too.

@scurest : Thank you for the supplement comment again. :)

@pioverfour: Thank you and sorry, I don't know any addon affected this change except Dream Texture. it's just my fault. I agree that this is correct behavior too. I remember Add Camera Rig and some addons (sorry, I forget them) had similar problem for bone constraints or modifiers which added by scripts, but it works fine now. so I believe Dream Texture (and other addons I don't know) will be fixed too. @scurest : Thank you for the supplement comment again. :)

Damien Picard commented

2023-01-26 23:36:29 +01:00

Thanks @scurest, I’m in the process of fixing the issue.

On second thought I’ll not be using the suggested fix though, as I’d rather get the nodes from their types than their translated names. I’m going with:

principled_node = next(n for n in material.node_tree.nodes if n.type == "BSDF_PRINCIPLED")

For the record, another possibility is:

principled_node, output_node = material.node_tree.nodes

or:

principled_node = material.node_tree.nodes[0]
output_node = material.node_tree.nodes[1]

but I’m not sure the order is expected to be stable so I’ll avoid it as well!

Thanks @scurest, I’m in the process of fixing the issue. On second thought I’ll not be using the suggested fix though, as I’d rather get the nodes from their types than their translated names. I’m going with: ``` principled_node = next(n for n in material.node_tree.nodes if n.type == "BSDF_PRINCIPLED") ``` For the record, another possibility is: ``` principled_node, output_node = material.node_tree.nodes ``` or: ``` principled_node = material.node_tree.nodes[0] output_node = material.node_tree.nodes[1] ``` but I’m not sure the order is expected to be stable so I’ll avoid it as well!

Bastien Montagne commented

2023-01-30 08:52:06 +01:00

The bug is indeed in the add-ons, not in 9d732445b9. Code should never, ever rely on a user-editable name to access data, unless it is explicitly given by the user, or set by that same code and checked for the actual final name as defined by Blender (since there can also be numeric suffixes etc.).

Accessing nodes by type or indices is also weak, but at least relatively consistent.

The bug is indeed in the add-ons, not in 9d732445b9. Code should never, ever rely on a user-editable name to access data, unless it is explicitly given by the user, or set by that same code and checked for the actual final name as defined by Blender (since there can also be numeric suffixes etc.). Accessing nodes by type or indices is also weak, but at least relatively consistent.

Bastien Montagne added this to the User Interface project 2023-02-09 15:34:10 +01:00

Damien Picard referenced this issue from blender/blender-addons

2023-02-09 21:30:45 +01:00

Magic UV: Get nodes with their types instead of names #104402

Damien Picard referenced this issue from a commit

2023-02-09 21:31:25 +01:00

Magic UV: Get nodes with their types instead of names

Damien Picard referenced this issue from a commit

2023-02-09 21:31:28 +01:00

Atomic Blender: Get nodes with their types instead of names

Damien Picard referenced this issue from blender/blender-addons

2023-02-09 21:32:37 +01:00