bl_i18n_utils - dump_addon_messages is missing addon's operator data and has redundant strings #116579

New Issue

Andrej · 2023-12-27T13:01:09+01:00

Andrej commented

2023-12-27 13:01:09 +01:00

Blender 4.0.2, perhaps ping @mont29

Not sure what's the better place for this issue - blender-addons or blender but since it's mostly caused by the way bl_extract_messages.py behaves, I've started it in blender.

Way to reproduce:

Create a new folder in blender addons subclasses_error and save init.py to that folder.
Open Blender and enable "Subclasses Error" addon in the preferences.
Use "Refresh I18n Data" in scene settings, choose "Subclasses Error" addon. (you'll need "Manage UI Translations" addon enabled and working).
Resulting translation.py added to subclasses_error directory is attached bellow. There are few issues:

it's missing operator's name and description (Subclasses error test name and Subclasses error test description)
it has couple redundant strings like Collection Definition, RNA collection property to define lists, arrays and mappings, etc

Couldn't reproduce it with simple example but for a big addon it has another problem - dump_rna_messages fails since I guess unregistered classes bl_rna is corrupted in a way and now contains corrupted symbols instead of bl_rna.identifier and it fails on this line trying to concatenate corrupted string.
06eda2a484/scripts/modules/bl_i18n_utils/bl_extract_messages.py (L411)

I've noticed something that perhaps is related - when some addon and it's classes unregistered it's operator classes are not removed from bpy.types.OperatorProperties.__subclasses__(). E.g. disabling and enabling the addon again will result in this:

[i for i in bpy.types.OperatorProperties.__subclasses__() if 'subclasses' in str(i).lower()]
# [<class 'bpy.types.SUBCLASSES_ERROR_OT_test'>]

# *disable and enable addon*

[i for i in bpy.types.OperatorProperties.__subclasses__() if 'subclasses' in str(i).lower()]
# [<class 'bpy.types.SUBCLASSES_ERROR_OT_test'>, <class 'bpy.types.SUBCLASSES_ERROR_OT_test'>]

I thought it's related since dump_rna_messages is relying on subclasses to find elements to parse. And the way dump_addon_messages work it saves messages A with addon enabled, then it disabled the addon, saves messages B and the difference between A and B is considered to be this addon's specific strings.
06eda2a484/scripts/modules/bl_i18n_utils/bl_extract_messages.py (L428)

__init__.py

import bpy
from bpy.types import Panel, Operator
from bpy.utils import register_class, unregister_class


bl_info = {
    'name': 'Subclasses Error',
    'category': 'All',
    'version': (1, 0, 0),
    'blender': (2, 91, 0),
}

class subclasses_test_error(Operator):
    bl_idname = 'subclasses_error.test'
    bl_label = 'Subclasses error test name'
    bl_description = "Subclasses error test description"

    def execute(self, context):
        return {'FINISHED'}


def register():
    register_class(subclasses_test_error)

def unregister():
    unregister_class(subclasses_test_error)

translations.py

# SPDX-License-Identifier: GPL-2.0-or-later


# ##### BEGIN AUTOGENERATED I18N SECTION #####


# NOTE: You can safely move around this auto-generated block (with the begin/end markers!),
#       and edit the translations by hand.
#       Just carefully respect the format of the tuple!

# Tuple of tuples:
# ((msgctxt, msgid), (sources, gen_comments), (lang, translation, (is_fuzzy, comments)), ...)
translations_tuple = (
    (("*", ""),
     ((), ()),
     ("de_DE", "Project-Id-Version: Subclasses Error 1.0.0 (0)\nReport-Msgid-Bugs-To: \nPOT-Creation-Date: 2023-12-27 16:39:40.786127\nPO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\nLast-Translator: FULL NAME <EMAIL@ADDRESS>\nLanguage-Team: LANGUAGE <LL@li.org>\nLanguage: __POT__\nMIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: 8bit",
               (False,
                ("Blender's translation file (po format).",
                 "Copyright (C) 2023 The Blender Authors.",
                 "This file is distributed under the same license as the Blender package.",
                 "FIRST AUTHOR <EMAIL@ADDRESS>, YEAR."))),
     ("ru_RU", "Project-Id-Version: Subclasses Error 1.0.0 (0)\nReport-Msgid-Bugs-To: \nPOT-Creation-Date: 2023-12-27 16:39:40.786127\nPO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\nLast-Translator: FULL NAME <EMAIL@ADDRESS>\nLanguage-Team: LANGUAGE <LL@li.org>\nLanguage: __POT__\nMIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: 8bit",
               (False,
                ("Blender's translation file (po format).",
                 "Copyright (C) 2023 The Blender Authors.",
                 "This file is distributed under the same license as the Blender package.",
                 "FIRST AUTHOR <EMAIL@ADDRESS>, YEAR."))),
    ),
    (("*", "Collection Definition"),
     (("bpy.types.CollectionProperty",),
      ()),
     ("de_DE", "",
               (False, ())),
     ("ru_RU", "",
               (False, ())),
    ),
    (("*", "RNA collection property to define lists, arrays and mappings"),
     (("bpy.types.CollectionProperty",),
      ()),
     ("de_DE", "",
               (False, ())),
     ("ru_RU", "",
               (False, ())),
    ),
    (("*", "Pointer Type"),
     (("bpy.types.CollectionProperty.fixed_type",),
      ()),
     ("de_DE", "",
               (False, ())),
     ("ru_RU", "",
               (False, ())),
    ),
    (("*", "Fixed pointer type, empty if variable type"),
     (("bpy.types.CollectionProperty.fixed_type",),
      ()),
     ("de_DE", "",
               (False, ())),
     ("ru_RU", "",
               (False, ())),
    ),
    (("*", "Subclasses Error"),
     (("Add-on Subclasses Error info: name",),
      ()),
     ("de_DE", "",
               (False, ())),
     ("ru_RU", "",
               (False, ())),
    ),
)

translations_dict = {}
for msg in translations_tuple:
    key = msg[0]
    for lang, trans, (is_fuzzy, comments) in msg[2:]:
        if trans and not is_fuzzy:
            translations_dict.setdefault(lang, {})[key] = trans



# ##### END AUTOGENERATED I18N SECTION #####

Blender 4.0.2, perhaps ping @mont29 Not sure what's the better place for this issue - blender-addons or blender but since it's mostly caused by the way [bl_extract_messages.py](https://projects.blender.org/blender/blender/src/branch/main/scripts/modules/bl_i18n_utils/bl_extract_messages.py) behaves, I've started it in blender. Way to reproduce: 1) Create a new folder in blender addons `subclasses_error` and save [__init__.py](/attachments/a513c4d8-2290-4baa-a363-f051c4838944) to that folder. 2) Open Blender and enable "Subclasses Error" addon in the preferences. 3) Use "Refresh I18n Data" in scene settings, choose "Subclasses Error" addon. (you'll need "Manage UI Translations" addon enabled and working). ![image](/attachments/04e8817d-291f-46ea-865a-df56c6d45217) 4) Resulting `translation.py` added to `subclasses_error` directory is attached bellow. There are few issues: - it's missing operator's name and description (`Subclasses error test name` and `Subclasses error test description`) - it has couple redundant strings like `Collection Definition`, `RNA collection property to define lists, arrays and mappings`, etc 5) Couldn't reproduce it with simple example but for a big addon it has another problem - `dump_rna_messages` fails since I guess unregistered classes `bl_rna` is corrupted in a way and now contains corrupted symbols instead of `bl_rna.identifier` and it fails on this line trying to concatenate corrupted string. https://projects.blender.org/blender/blender/src/commit/06eda2a484b8ab4ac6685e652dd153a16a3735e3/scripts/modules/bl_i18n_utils/bl_extract_messages.py#L411 I've noticed something that perhaps is related - when some addon and it's classes unregistered it's operator classes are not removed from `bpy.types.OperatorProperties.__subclasses__()`. E.g. disabling and enabling the addon again will result in this: ```python [i for i in bpy.types.OperatorProperties.__subclasses__() if 'subclasses' in str(i).lower()] # [<class 'bpy.types.SUBCLASSES_ERROR_OT_test'>] # *disable and enable addon* [i for i in bpy.types.OperatorProperties.__subclasses__() if 'subclasses' in str(i).lower()] # [<class 'bpy.types.SUBCLASSES_ERROR_OT_test'>, <class 'bpy.types.SUBCLASSES_ERROR_OT_test'>] ``` I thought it's related since `dump_rna_messages` is relying on subclasses to find elements to parse. And the way `dump_addon_messages` work it saves messages A with addon enabled, then it disabled the addon, saves messages B and the difference between A and B is considered to be this addon's specific strings. https://projects.blender.org/blender/blender/src/commit/06eda2a484b8ab4ac6685e652dd153a16a3735e3/scripts/modules/bl_i18n_utils/bl_extract_messages.py#L428 `__init__.py` ```python import bpy from bpy.types import Panel, Operator from bpy.utils import register_class, unregister_class bl_info = { 'name': 'Subclasses Error', 'category': 'All', 'version': (1, 0, 0), 'blender': (2, 91, 0), } class subclasses_test_error(Operator): bl_idname = 'subclasses_error.test' bl_label = 'Subclasses error test name' bl_description = "Subclasses error test description" def execute(self, context): return {'FINISHED'} def register(): register_class(subclasses_test_error) def unregister(): unregister_class(subclasses_test_error) ``` `translations.py` ```python # SPDX-License-Identifier: GPL-2.0-or-later # ##### BEGIN AUTOGENERATED I18N SECTION ##### # NOTE: You can safely move around this auto-generated block (with the begin/end markers!), # and edit the translations by hand. # Just carefully respect the format of the tuple! # Tuple of tuples: # ((msgctxt, msgid), (sources, gen_comments), (lang, translation, (is_fuzzy, comments)), ...) translations_tuple = ( (("*", ""), ((), ()), ("de_DE", "Project-Id-Version: Subclasses Error 1.0.0 (0)\nReport-Msgid-Bugs-To: \nPOT-Creation-Date: 2023-12-27 16:39:40.786127\nPO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\nLast-Translator: FULL NAME <EMAIL@ADDRESS>\nLanguage-Team: LANGUAGE <LL@li.org>\nLanguage: __POT__\nMIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: 8bit", (False, ("Blender's translation file (po format).", "Copyright (C) 2023 The Blender Authors.", "This file is distributed under the same license as the Blender package.", "FIRST AUTHOR <EMAIL@ADDRESS>, YEAR."))), ("ru_RU", "Project-Id-Version: Subclasses Error 1.0.0 (0)\nReport-Msgid-Bugs-To: \nPOT-Creation-Date: 2023-12-27 16:39:40.786127\nPO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\nLast-Translator: FULL NAME <EMAIL@ADDRESS>\nLanguage-Team: LANGUAGE <LL@li.org>\nLanguage: __POT__\nMIME-Version: 1.0\nContent-Type: text/plain; charset=UTF-8\nContent-Transfer-Encoding: 8bit", (False, ("Blender's translation file (po format).", "Copyright (C) 2023 The Blender Authors.", "This file is distributed under the same license as the Blender package.", "FIRST AUTHOR <EMAIL@ADDRESS>, YEAR."))), ), (("*", "Collection Definition"), (("bpy.types.CollectionProperty",), ()), ("de_DE", "", (False, ())), ("ru_RU", "", (False, ())), ), (("*", "RNA collection property to define lists, arrays and mappings"), (("bpy.types.CollectionProperty",), ()), ("de_DE", "", (False, ())), ("ru_RU", "", (False, ())), ), (("*", "Pointer Type"), (("bpy.types.CollectionProperty.fixed_type",), ()), ("de_DE", "", (False, ())), ("ru_RU", "", (False, ())), ), (("*", "Fixed pointer type, empty if variable type"), (("bpy.types.CollectionProperty.fixed_type",), ()), ("de_DE", "", (False, ())), ("ru_RU", "", (False, ())), ), (("*", "Subclasses Error"), (("Add-on Subclasses Error info: name",), ()), ("de_DE", "", (False, ())), ("ru_RU", "", (False, ())), ), ) translations_dict = {} for msg in translations_tuple: key = msg[0] for lang, trans, (is_fuzzy, comments) in msg[2:]: if trans and not is_fuzzy: translations_dict.setdefault(lang, {})[key] = trans # ##### END AUTOGENERATED I18N SECTION ##### ```

__init__.py

649 B

image.png

6.8 KiB

Andrej added the

labels 2023-12-27 13:01:10 +01:00

Pratik Borhade commented

2023-12-28 07:34:44 +01:00

Hi, thanks for the report. Do we require translation repo as well? I've been asked to init i18n settings but following 3 operations are not showing up afterwards due to if not i18n_sett.is_init:
(Translation root looks wrong to me in preferences)
image
image

Hi, thanks for the report. Do we require `translation` repo as well? I've been asked to init i18n settings but following 3 operations are not showing up afterwards due to `if not i18n_sett.is_init:` (Translation root looks wrong to me in preferences) [image](/attachments/607b567a-4a1c-4860-917b-3225ec557196) [image](/attachments/0b377ddb-3e67-48b9-bf57-3ec795155679)

image.png

29 KiB

image.png

13 KiB

👍 1

Pratik Borhade added

Status

Needs Information from User

and removed

Status

Needs Triage

labels 2023-12-28 07:35:09 +01:00

Andrej commented

2023-12-28 14:08:04 +01:00

@PratikPB2123
Well, it probably does require translation repo but for my case I was just translating an addon and only needed access to those operators that can retrieve some addon’s strings, so I just used some dummy directories like C:/Blender/source for SOURCE_DIR (note that, need to make sure it has directories locale/po inside) and C:/Blender/i18 for I18N_DIR.

@PratikPB2123 Well, it probably does require `translation` repo but for my case I was just translating an addon and only needed access to those operators that can retrieve some addon’s strings, so I just used some dummy directories like `C:/Blender/source` for `SOURCE_DIR` (note that, need to make sure it has directories `locale/po` inside) and `C:/Blender/i18` for `I18N_DIR`.

Pratik Borhade added

Status

Needs Triage

and removed

Status

Needs Information from User

labels 2024-01-01 11:00:52 +01:00

Damien Picard added the