I18n: Remove extraction macros from the node socket declarations #107258

Merged

Bastien Montagne merged 3 commits from pioverfour/blender:dp_geo_nodes_remove_extraction_macros into main

2023-05-16 14:13:01 +02:00

Damien Picard commented

2023-04-23 03:59:36 +02:00

Member

The node socket declaration uses the N_() macro to extract the name
and description of the socket.

This is quite redundant because since the syntax is always the same,
the extraction can be done automatically from the Python translation
module using regexes.

Four new regexes are introduced in bl_i18n_utils.settings:

one extracts contextless messages from add_input() and
add_output(), the basic socket declarations with the names;
one does the same, but for those sockets which declare a context
through .translation_context();
one extracts descriptions and error messages;
one extracts geometry nodes field inputs.

In addition to making the code simpler and more legible, this change
extracts a few dozen messages which were not tagged with the proper
macro.

The node socket declaration uses the `N_()` macro to extract the name and description of the socket. This is quite redundant because since the syntax is always the same, the extraction can be done automatically from the Python translation module using regexes. Four new regexes are introduced in bl_i18n_utils.settings: - one extracts contextless messages from `add_input()` and `add_output()`, the basic socket declarations with the names; - one does the same, but for those sockets which declare a context through `.translation_context()`; - one extracts descriptions and error messages; - one extracts geometry nodes field inputs. In addition to making the code simpler and more legible, this change extracts a few dozen messages which were not tagged with the proper macro.

Damien Picard added the

Nodes & Physics

labels 2023-04-23 04:01:08 +02:00

Damien Picard requested review from Bastien Montagne 2023-04-23 04:01:14 +02:00

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from a3ed424c39 to bc05c95da5

2023-04-23 16:22:40 +02:00

Compare

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from bc05c95da5 to 51040b560f

2023-04-24 21:26:14 +02:00

Compare

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 51040b560f to 75cacf6663

2023-04-24 22:11:41 +02:00

Compare

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 75cacf6663 to 4026419109

2023-04-25 15:44:12 +02:00

Compare

Bastien Montagne reviewed 2023-04-28 19:17:34 +02:00

Bastien Montagne left a comment

Owner

While this change may be fine in current status of node code, I have tow concerns:

First, names like add_input are very generic and could easily conflict with future code. Don't really see a good way to address that though.

The second one is more a topic for the #Nodes-&-Physics module, but I find it fairly annoying that such a huge part of Blender is not properly available to introspection through RNA?

While this change may be fine in current status of node code, I have tow concerns: First, names like `add_input` are _very_ generic and could easily conflict with future code. Don't really see a good way to address that though. The second one is more a topic for the #Nodes-&-Physics module, but I find it fairly annoying that such a huge part of Blender is not properly available to introspection through RNA?

scripts/modules/bl_i18n_utils/settings.py Outdated

						
				@ -257,2 +257,4 @@

				          for it in ("modifier_subpanel_register", "gpencil_modifier_subpanel_register")) +

				    # Node socket declarations: contextless names

				    tuple((r"\.{}<decl::.*?>\(\s*" + _msg_re + r"\s*\)").format(it)

Bastien Montagne commented

2023-04-28 18:47:02 +02:00

Owner

I don't think this will handle properly cases with more than one string passed to the constructor, like in b.add_input<decl::Float>("Value", "Value_001") ?

I don't think this will handle properly cases with more than one string passed to the constructor, like in ` b.add_input<decl::Float>("Value", "Value_001")` ?

Damien Picard commented

2023-04-28 23:55:50 +02:00

Author

Member

I don't think this will handle properly cases with more than one string passed to the constructor, like in b.add_input<decl::Float>("Value", "Value_001") ?

My understanding from this block is that the second string is only an identifier and can always be ignored for translation. Also at present, every instance where add_(in|out)put() is called with two arguments, only the first one has a N_() extraction tag.

> I don't think this will handle properly cases with more than one string passed to the constructor, like in ` b.add_input<decl::Float>("Value", "Value_001")` ? My understanding from [this block](https://projects.blender.org/blender/blender/src/branch/main/source/blender/nodes/NOD_node_declaration.hh#L515-L518) is that the second string is only an identifier and can always be ignored for translation. Also at present, every instance where `add_(in|out)put()` is called with two arguments, only the first one has a `N_()` extraction tag.

Hans Goudey commented

2023-05-02 16:20:24 +02:00

Member

Yes, that's right

Yes, that's right

Bastien Montagne commented

2023-05-02 18:02:19 +02:00

Owner

@pioverfour I was not clear enough here, my concern is that the current regex will not match on multi-parameters cases. The r"\s*\)" part of the regex requires zero or more 'space-like' chars and a closing ).

See e.g. how modifier_subpanel_register & co are handled. You probably need to add something like r"(?:,[^),]+)*\s*\)" (or + instead of * if there can ever only be one additional optional parameter) to match & discard any extra parameter...

@pioverfour I was not clear enough here, my concern is that the current regex will not match on multi-parameters cases. The `r"\s*\)"` part of the regex requires zero or more 'space-like' chars and a closing `)`. See e.g. how `modifier_subpanel_register` & co are handled. You probably need to add something like `r"(?:,[^),]+)*\s*\)"` (or `+` instead of `*` if there can ever only be one additional optional parameter) to match & discard any extra parameter...

Damien Picard commented

2023-05-07 16:52:49 +02:00

Author

Member

Ah, yes of course! Thanks.

Ah, yes of course! Thanks.

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 4026419109 to 085a84f9d9

2023-04-29 00:04:31 +02:00

Compare

Hans Goudey commented

2023-05-02 16:20:10 +02:00

Member

but I find it fairly annoying that such a huge part of Blender is not properly available to introspection through RNA?

This is an ongoing pain point for us too, but the transition from the static socket array for nodes to the socket declaration is a large one and we don't want to expose it to RNA while it's still changing. It is on our radar though.

>but I find it fairly annoying that such a huge part of Blender is not properly available to introspection through RNA? This is an ongoing pain point for us too, but the transition from the static socket array for nodes to the socket declaration is a large one and we don't want to expose it to RNA while it's still changing. It is on our radar though.

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 085a84f9d9 to a0013d616a

2023-05-07 16:48:07 +02:00

Compare

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from a0013d616a to 6c2c5d2feb

2023-05-10 12:02:13 +02:00

Compare

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 6c2c5d2feb to 5c93654067

2023-05-13 17:53:22 +02:00

Compare

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 5c93654067 to 04525f8bcb

2023-05-15 18:46:44 +02:00

Compare

Damien Picard commented

2023-05-15 18:48:45 +02:00

Author

Member

While I was rebasing on latest main to resolve conflicts, I noticed that some labels come from the node_sock_label() function. So I added a new commit in between the existing ones, with the new regex:

    # Node socket labels
    tuple((r"{}\(\s*[^,]+,\s*" + _msg_re + r"\s*\)").format(it)
          for it in ("node_sock_label",)) +

While I was rebasing on latest main to resolve conflicts, I noticed that some labels come from the `node_sock_label()` function. So I added a new commit in between the existing ones, with the new regex: ```python # Node socket labels tuple((r"{}\(\s*[^,]+,\s*" + _msg_re + r"\s*\)").format(it) for it in ("node_sock_label",)) + ```

Bastien Montagne approved these changes 2023-05-15 18:49:14 +02:00

Bastien Montagne commented

2023-05-15 18:49:39 +02:00

Owner

@pioverfour looks like this PR needs to be updated by hands ;)

@pioverfour looks like this PR needs to be updated by hands ;)

Bastien Montagne commented

2023-05-15 18:50:24 +02:00

Owner

Oh, hehe, looks we have been colliding...

Oh, hehe, looks we have been colliding...

Iliya Katushenock commented

2023-05-15 18:52:09 +02:00

Member

Sorry, surprised we could...

Sorry, surprised we could...

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from 04525f8bcb to e149997be1

2023-05-15 18:59:19 +02:00

Compare

Bastien Montagne commented

2023-05-15 19:07:12 +02:00

Owner

@blender-bot build

@blender-bot build

Damien Picard force-pushed dp_geo_nodes_remove_extraction_macros from e149997be1 to 9b313102bb

2023-05-15 22:34:05 +02:00

Compare

Bastien Montagne merged commit 22f641e7f8 into main

2023-05-16 14:13:01 +02:00

Bastien Montagne deleted branch dp_geo_nodes_remove_extraction_macros

2023-05-16 14:13:02 +02:00

Bastien Montagne referenced this issue from a commit

2023-05-16 14:13:09 +02:00

Cleanup: I18n: Remove extraction macros from node socket declarations

Falk David referenced this issue from a commit

2023-05-23 14:35:33 +02:00

Cleanup: I18n: Remove extraction macros from node socket declarations

Howard Trickey referenced this issue from a commit

2023-05-29 02:51:39 +02:00

Merge in orign/main:

Habib Gahbiche referenced this pull request

2023-08-15 23:05:54 +02:00

Cleanup: i18n remove extraction macro from Kuwahara node #111151

Bastien Montagne referenced this issue from a commit

2023-08-21 16:48:33 +02:00

Cleanup: i18n: remove extraction macro from some geometry nodes

Sign in to join this conversation.

No reviewers

No Label

Animation & Rigging

Asset Browser Project Overview

Automated Testing

Blender Asset Bundle

Dependency Graph

Development Management

EEVEE & Viewport

Images & Movies

Motion Tracking

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Render Pipeline

Sculpt, Paint & Texture

Video Sequencer

Virtual Reality

Blender 2.8 Project

Milestone 1: Basic, Local Asset Browser

Good First Issue

Animation & Rigging

Development Management

EEVEE & Viewport

Nodes & Physics

Pipeline, Assets & IO

Platforms, Builds & Tests

Render & Cycles

Sculpt, Paint & Texture

Needs Info from Developers

Needs Information from User

No Milestone

No project

No Assignees

4 Participants

Notifications

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: blender/blender#107258

No description provided.