3b7eff6db9cfd7ef64dfcbeeab05f31750fb7252
[blender-staging.git] / release / scripts / modules / bl_i18n_utils / bl_extract_messages.py
1 # ***** BEGIN GPL LICENSE BLOCK *****
2 #
3 # This program is free software; you can redistribute it and/or
4 # modify it under the terms of the GNU General Public License
5 # as published by the Free Software Foundation; either version 2
6 # of the License, or (at your option) any later version.
7 #
8 # This program is distributed in the hope that it will be useful,
9 # but WITHOUT ANY WARRANTY; without even the implied warranty of
10 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11 # GNU General Public License for more details.
12 #
13 # You should have received a copy of the GNU General Public License
14 # along with this program; if not, write to the Free Software Foundation,
15 # Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
16 #
17 # ***** END GPL LICENSE BLOCK *****
18
19 # <pep8 compliant>
20
21 # Populate a template file (POT format currently) from Blender RNA/py/C data.
22 # XXX: This script is meant to be used from inside Blender!
23 #      You should not directly use this script, rather use update_msg.py!
24
25 import collections
26 import copy
27 import datetime
28 import os
29 import re
30 import sys
31
32 # XXX Relative import does not work here when used from Blender...
33 from bl_i18n_utils import settings as settings_i18n, utils
34
35 import bpy
36
37 ##### Utils #####
38
39 # check for strings like "+%f°"
40 ignore_reg = re.compile(r"^(?:[-*.()/\\+%°0-9]|%d|%f|%s|%r|\s)*$")
41 filter_message = ignore_reg.match
42
43
44 def init_spell_check(settings, lang="en_US"):
45     try:
46         from bl_i18n_utils import utils_spell_check
47         return utils_spell_check.SpellChecker(settings, lang)
48     except Exception as e:
49         print("Failed to import utils_spell_check ({})".format(str(e)))
50         return None
51
52
53 def _gen_check_ctxt(settings):
54     return {
55         "multi_rnatip": set(),
56         "multi_lines": set(),
57         "py_in_rna": set(),
58         "not_capitalized": set(),
59         "end_point": set(),
60         "undoc_ops": set(),
61         "spell_checker": init_spell_check(settings),
62         "spell_errors": {},
63     }
64
65
66 def _diff_check_ctxt(check_ctxt, minus_check_ctxt):
67     """Removes minus_check_ctxt from check_ctxt"""
68     for key in check_ctxt:
69         if isinstance(check_ctxt[key], set):
70             for warning in minus_check_ctxt[key]:
71                 if warning in check_ctxt[key]:
72                     check_ctxt[key].remove(warning)
73         elif isinstance(check_ctxt[key], dict):
74             for warning in minus_check_ctxt[key]:
75                 if warning in check_ctxt[key]:
76                     del check_ctxt[key][warning]
77
78
79 def _gen_reports(check_ctxt):
80     return {
81         "check_ctxt": check_ctxt,
82         "rna_structs": [],
83         "rna_structs_skipped": [],
84         "rna_props": [],
85         "rna_props_skipped": [],
86         "py_messages": [],
87         "py_messages_skipped": [],
88         "src_messages": [],
89         "src_messages_skipped": [],
90         "messages_skipped": set(),
91     }
92
93
94 def check(check_ctxt, msgs, key, msgsrc, settings):
95     """
96     Performs a set of checks over the given key (context, message)...
97     """
98     if check_ctxt is None:
99         return
100     multi_rnatip = check_ctxt.get("multi_rnatip")
101     multi_lines = check_ctxt.get("multi_lines")
102     py_in_rna = check_ctxt.get("py_in_rna")
103     not_capitalized = check_ctxt.get("not_capitalized")
104     end_point = check_ctxt.get("end_point")
105     undoc_ops = check_ctxt.get("undoc_ops")
106     spell_checker = check_ctxt.get("spell_checker")
107     spell_errors = check_ctxt.get("spell_errors")
108
109     if multi_rnatip is not None:
110         if key in msgs and key not in multi_rnatip:
111             multi_rnatip.add(key)
112     if multi_lines is not None:
113         if '\n' in key[1]:
114             multi_lines.add(key)
115     if py_in_rna is not None:
116         if key in py_in_rna[1]:
117             py_in_rna[0].add(key)
118     if not_capitalized is not None:
119         if(key[1] not in settings.WARN_MSGID_NOT_CAPITALIZED_ALLOWED and
120            key[1][0].isalpha() and not key[1][0].isupper()):
121             not_capitalized.add(key)
122     if end_point is not None:
123         if (key[1].strip().endswith('.') and not key[1].strip().endswith('...') and
124             key[1] not in settings.WARN_MSGID_END_POINT_ALLOWED):
125             end_point.add(key)
126     if undoc_ops is not None:
127         if key[1] == settings.UNDOC_OPS_STR:
128             undoc_ops.add(key)
129     if spell_checker is not None and spell_errors is not None:
130         err = spell_checker.check(key[1])
131         if err:
132             spell_errors[key] = err
133
134
135 def print_info(reports, pot):
136     def _print(*args, **kwargs):
137         kwargs["file"] = sys.stderr
138         print(*args, **kwargs)
139
140     pot.update_info()
141
142     _print("{} RNA structs were processed (among which {} were skipped), containing {} RNA properties "
143            "(among which {} were skipped).".format(len(reports["rna_structs"]), len(reports["rna_structs_skipped"]),
144                                                    len(reports["rna_props"]), len(reports["rna_props_skipped"])))
145     _print("{} messages were extracted from Python UI code (among which {} were skipped), and {} from C source code "
146            "(among which {} were skipped).".format(len(reports["py_messages"]), len(reports["py_messages_skipped"]),
147                                                    len(reports["src_messages"]), len(reports["src_messages_skipped"])))
148     _print("{} messages were rejected.".format(len(reports["messages_skipped"])))
149     _print("\n")
150     _print("Current POT stats:")
151     pot.print_info(prefix="\t", output=_print)
152     _print("\n")
153
154     check_ctxt = reports["check_ctxt"]
155     if check_ctxt is None:
156         return
157     multi_rnatip = check_ctxt.get("multi_rnatip")
158     multi_lines = check_ctxt.get("multi_lines")
159     py_in_rna = check_ctxt.get("py_in_rna")
160     not_capitalized = check_ctxt.get("not_capitalized")
161     end_point = check_ctxt.get("end_point")
162     undoc_ops = check_ctxt.get("undoc_ops")
163     spell_errors = check_ctxt.get("spell_errors")
164
165     # XXX Temp, no multi_rnatip nor py_in_rna, see below.
166     keys = multi_lines | not_capitalized | end_point | undoc_ops | spell_errors.keys()
167     if keys:
168         _print("WARNINGS:")
169         for key in keys:
170             if undoc_ops and key in undoc_ops:
171                 _print("\tThe following operators are undocumented!")
172             else:
173                 _print("\t“{}”|“{}”:".format(*key))
174                 if multi_lines and key in multi_lines:
175                     _print("\t\t-> newline in this message!")
176                 if not_capitalized and key in not_capitalized:
177                     _print("\t\t-> message not capitalized!")
178                 if end_point and key in end_point:
179                     _print("\t\t-> message with endpoint!")
180                 # XXX Hide this one for now, too much false positives.
181 #                if multi_rnatip and key in multi_rnatip:
182 #                    _print("\t\t-> tip used in several RNA items")
183 #                if py_in_rna and key in py_in_rna:
184 #                    _print("\t\t-> RNA message also used in py UI code!")
185                 if spell_errors and spell_errors.get(key):
186                     lines = ["\t\t-> {}: misspelled, suggestions are ({})".format(w, "'" + "', '".join(errs) + "'")
187                              for w, errs in  spell_errors[key]]
188                     _print("\n".join(lines))
189             _print("\t\t{}".format("\n\t\t".join(pot.msgs[key].sources)))
190
191
192 def process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt, settings):
193     if filter_message(msgid):
194         reports["messages_skipped"].add((msgid, msgsrc))
195         return
196     if not msgctxt:
197         # We do *not* want any "" context!
198         msgctxt = settings.DEFAULT_CONTEXT
199     # Always unescape keys!
200     msgctxt = utils.I18nMessage.do_unescape(msgctxt)
201     msgid = utils.I18nMessage.do_unescape(msgid)
202     key = (msgctxt, msgid)
203     check(check_ctxt, msgs, key, msgsrc, settings)
204     msgsrc = settings.PO_COMMENT_PREFIX_SOURCE_CUSTOM + msgsrc
205     if key not in msgs:
206         msgs[key] = utils.I18nMessage([msgctxt], [msgid], [], [msgsrc], settings=settings)
207     else:
208         msgs[key].comment_lines.append(msgsrc)
209
210
211 ##### RNA #####
212 def dump_rna_messages(msgs, reports, settings, verbose=False):
213     """
214     Dump into messages dict all RNA-defined UI messages (labels en tooltips).
215     """
216     def class_blacklist():
217         blacklist_rna_class = {getattr(bpy.types, cls_id) for cls_id in (
218                 # core classes
219                 "Context", "Event", "Function", "UILayout", "UnknownType", "Property", "Struct",
220                 # registerable classes
221                 "Panel", "Menu", "Header", "RenderEngine", "Operator", "OperatorMacro", "Macro", "KeyingSetInfo",
222                 # window classes
223                 "Window",
224             )
225         }
226
227         # More builtin classes we don't need to parse.
228         blacklist_rna_class |= {cls for cls in bpy.types.Property.__subclasses__()}
229
230         _rna = {getattr(bpy.types, cls) for cls in dir(bpy.types)}
231
232         # Classes which are attached to collections can be skipped too, these are api access only.
233         # XXX This is not true, some of those show in UI, see e.g. tooltip of KeyingSets.active...
234         #~ for cls in _rna:
235             #~ for prop in cls.bl_rna.properties:
236                 #~ if prop.type == 'COLLECTION':
237                     #~ prop_cls = prop.srna
238                     #~ if prop_cls is not None:
239                         #~ blacklist_rna_class.add(prop_cls.__class__)
240
241         # Now here is the *ugly* hack!
242         # Unfortunately, all classes we want to access are not available from bpy.types (OperatorProperties subclasses
243         # are not here, as they have the same name as matching Operator ones :( ). So we use __subclasses__() calls
244         # to walk through all rna hierachy.
245         # But unregistered classes remain listed by relevant __subclasses__() calls (be it a Py or BPY/RNA bug),
246         # and obviously the matching RNA struct exists no more, so trying to access their data (even the identifier)
247         # quickly leads to segfault!
248         # To address this, we have to blacklist classes which __name__ does not match any __name__ from bpy.types
249         # (we can't use only RNA identifiers, as some py-defined classes has a different name that rna id,
250         # and we can't use class object themselves, because OperatorProperties subclasses are not in bpy.types!)...
251
252         _rna_clss_ids = {cls.__name__ for cls in _rna} | {cls.bl_rna.identifier for cls in _rna}
253
254         # All registrable types.
255         blacklist_rna_class |= {cls for cls in bpy.types.OperatorProperties.__subclasses__() +
256                                                bpy.types.Operator.__subclasses__() +
257                                                bpy.types.OperatorMacro.__subclasses__() +
258                                                bpy.types.Header.__subclasses__() +
259                                                bpy.types.Panel.__subclasses__() +
260                                                bpy.types.Menu.__subclasses__() +
261                                                bpy.types.UIList.__subclasses__()
262                                     if cls.__name__ not in _rna_clss_ids}
263
264         # Collect internal operators
265         # extend with all internal operators
266         # note that this uses internal api introspection functions
267         # XXX Do not skip INTERNAL's anymore, some of those ops show up in UI now!
268         # all possible operator names
269         #op_ids = (set(cls.bl_rna.identifier for cls in bpy.types.OperatorProperties.__subclasses__()) |
270         #          set(cls.bl_rna.identifier for cls in bpy.types.Operator.__subclasses__()) |
271         #          set(cls.bl_rna.identifier for cls in bpy.types.OperatorMacro.__subclasses__()))
272
273         #get_instance = __import__("_bpy").ops.get_instance
274         #path_resolve = type(bpy.context).__base__.path_resolve
275         #for idname in op_ids:
276             #op = get_instance(idname)
277             #if 'INTERNAL' in path_resolve(op, "bl_options"):
278                 #blacklist_rna_class.add(idname)
279
280         return blacklist_rna_class
281
282     check_ctxt_rna = check_ctxt_rna_tip = None
283     check_ctxt = reports["check_ctxt"]
284     if check_ctxt:
285         check_ctxt_rna = {
286             "multi_lines": check_ctxt.get("multi_lines"),
287             "not_capitalized": check_ctxt.get("not_capitalized"),
288             "end_point": check_ctxt.get("end_point"),
289             "undoc_ops": check_ctxt.get("undoc_ops"),
290             "spell_checker": check_ctxt.get("spell_checker"),
291             "spell_errors": check_ctxt.get("spell_errors"),
292         }
293         check_ctxt_rna_tip = check_ctxt_rna
294         check_ctxt_rna_tip["multi_rnatip"] = check_ctxt.get("multi_rnatip")
295
296     default_context = settings.DEFAULT_CONTEXT
297
298     # Function definitions
299     def walk_properties(cls):
300         bl_rna = cls.bl_rna
301         # Get our parents' properties, to not export them multiple times.
302         bl_rna_base = bl_rna.base
303         if bl_rna_base:
304             bl_rna_base_props = set(bl_rna_base.properties.values())
305         else:
306             bl_rna_base_props = set()
307
308         props = sorted(bl_rna.properties, key=lambda p: p.identifier)
309         for prop in props:
310             # Only write this property if our parent hasn't got it.
311             if prop in bl_rna_base_props:
312                 continue
313             if prop.identifier == "rna_type":
314                 continue
315             reports["rna_props"].append((cls, prop))
316
317             msgsrc = "bpy.types.{}.{}".format(bl_rna.identifier, prop.identifier)
318             msgctxt = prop.translation_context or default_context
319
320             if prop.name and (prop.name != prop.identifier or msgctxt != default_context):
321                 process_msg(msgs, msgctxt, prop.name, msgsrc, reports, check_ctxt_rna, settings)
322             if prop.description:
323                 process_msg(msgs, default_context, prop.description, msgsrc, reports, check_ctxt_rna_tip, settings)
324
325             if isinstance(prop, bpy.types.EnumProperty):
326                 done_items = set()
327                 for item in prop.enum_items:
328                     msgsrc = "bpy.types.{}.{}:'{}'".format(bl_rna.identifier, prop.identifier, item.identifier)
329                     done_items.add(item.identifier)
330                     if item.name and item.name != item.identifier:
331                         process_msg(msgs, msgctxt, item.name, msgsrc, reports, check_ctxt_rna, settings)
332                     if item.description:
333                         process_msg(msgs, default_context, item.description, msgsrc, reports, check_ctxt_rna_tip,
334                                     settings)
335                 for item in prop.enum_items_static:
336                     if item.identifier in done_items:
337                         continue
338                     msgsrc = "bpy.types.{}.{}:'{}'".format(bl_rna.identifier, prop.identifier, item.identifier)
339                     done_items.add(item.identifier)
340                     if item.name and item.name != item.identifier:
341                         process_msg(msgs, msgctxt, item.name, msgsrc, reports, check_ctxt_rna, settings)
342                     if item.description:
343                         process_msg(msgs, default_context, item.description, msgsrc, reports, check_ctxt_rna_tip,
344                                     settings)
345
346     blacklist_rna_class = class_blacklist()
347
348     def walk_class(cls):
349         bl_rna = cls.bl_rna
350         msgsrc = "bpy.types." + bl_rna.identifier
351         msgctxt = bl_rna.translation_context or default_context
352
353         if bl_rna.name and (bl_rna.name != bl_rna.identifier or msgctxt != default_context):
354             process_msg(msgs, msgctxt, bl_rna.name, msgsrc, reports, check_ctxt_rna, settings)
355
356         if bl_rna.description:
357             process_msg(msgs, default_context, bl_rna.description, msgsrc, reports, check_ctxt_rna_tip, settings)
358         elif cls.__doc__:  # XXX Some classes (like KeyingSetInfo subclasses) have void description... :(
359             process_msg(msgs, default_context, cls.__doc__, msgsrc, reports, check_ctxt_rna_tip, settings)
360
361         # Panels' "tabs" system.
362         if hasattr(bl_rna, 'bl_category') and bl_rna.bl_category:
363             process_msg(msgs, default_context, bl_rna.bl_category, msgsrc, reports, check_ctxt_rna, settings)
364
365         if hasattr(bl_rna, 'bl_label') and bl_rna.bl_label:
366             process_msg(msgs, msgctxt, bl_rna.bl_label, msgsrc, reports, check_ctxt_rna, settings)
367
368         walk_properties(cls)
369
370     def walk_keymap_hierarchy(hier, msgsrc_prev):
371         km_i18n_context = bpy.app.translations.contexts.id_windowmanager
372         for lvl in hier:
373             msgsrc = msgsrc_prev + "." + lvl[1]
374             process_msg(msgs, km_i18n_context, lvl[0], msgsrc, reports, None, settings)
375             if lvl[3]:
376                 walk_keymap_hierarchy(lvl[3], msgsrc)
377
378     # Dump Messages
379     operator_categories = {}
380     def process_cls_list(cls_list):
381         if not cls_list:
382             return
383
384         def full_class_id(cls):
385             """Gives us 'ID.Lamp.AreaLamp' which is best for sorting."""
386             # Always the same issue, some classes listed in blacklist should actually no more exist (they have been
387             # unregistered), but are still listed by __subclasses__() calls... :/
388             if cls in blacklist_rna_class:
389                 return cls.__name__
390             cls_id = ""
391             bl_rna = cls.bl_rna
392             while bl_rna:
393                 cls_id = bl_rna.identifier + "." + cls_id
394                 bl_rna = bl_rna.base
395             return cls_id
396
397         def operator_category(cls):
398             """Extract operators' categories, as displayed in 'search' space menu."""
399             # NOTE: keep in sync with C code in ui_searchbox_region_draw_cb__operator().
400             if issubclass(cls, bpy.types.OperatorProperties) and "_OT_" in cls.__name__:
401                 cat_id = cls.__name__.split("_OT_")[0]
402                 if cat_id not in operator_categories:
403                     cat_str = cat_id.capitalize() + ":"
404                     operator_categories[cat_id] = cat_str
405
406         if verbose:
407             print(cls_list)
408         cls_list.sort(key=full_class_id)
409         for cls in cls_list:
410             if verbose:
411                 print(cls)
412             reports["rna_structs"].append(cls)
413             # Ignore those Operator sub-classes (anyway, will get the same from OperatorProperties sub-classes!)...
414             if (cls in blacklist_rna_class) or issubclass(cls, bpy.types.Operator):
415                 reports["rna_structs_skipped"].append(cls)
416             else:
417                 operator_category(cls)
418                 walk_class(cls)
419             # Recursively process subclasses.
420             process_cls_list(cls.__subclasses__())
421
422     # Parse everything (recursively parsing from bpy_struct "class"...).
423     process_cls_list(bpy.types.ID.__base__.__subclasses__())
424
425     # Finalize generated 'operator categories' messages.
426     for cat_str in operator_categories.values():
427         process_msg(msgs, bpy.app.translations.contexts.operator_default, cat_str, "Generated operator category",
428                     reports, check_ctxt_rna, settings)
429
430     # And parse keymaps!
431     from bpy_extras.keyconfig_utils import KM_HIERARCHY
432     walk_keymap_hierarchy(KM_HIERARCHY, "KM_HIERARCHY")
433
434
435 ##### Python source code #####
436 def dump_py_messages_from_files(msgs, reports, files, settings):
437     """
438     Dump text inlined in the python files given, e.g. 'My Name' in:
439         layout.prop("someprop", text="My Name")
440     """
441     import ast
442
443     bpy_struct = bpy.types.ID.__base__
444     i18n_contexts = bpy.app.translations.contexts
445
446     root_paths = tuple(bpy.utils.resource_path(t) for t in ('USER', 'LOCAL', 'SYSTEM'))
447     def make_rel(path):
448         for rp in root_paths:
449             if path.startswith(rp):
450                 try:  # can't always find the relative path (between drive letters on windows)
451                     return os.path.relpath(path, rp)
452                 except ValueError:
453                     return path
454         # Use binary's dir as fallback...
455         try:  # can't always find the relative path (between drive letters on windows)
456             return os.path.relpath(path, os.path.dirname(bpy.app.binary_path))
457         except ValueError:
458             return path
459
460     # Helper function
461     def extract_strings_ex(node, is_split=False):
462         """
463         Recursively get strings, needed in case we have "Blah" + "Blah", passed as an argument in that case it won't
464         evaluate to a string. However, break on some kind of stopper nodes, like e.g. Subscript.
465         """
466         if type(node) == ast.Str:
467             eval_str = ast.literal_eval(node)
468             if eval_str:
469                 yield (is_split, eval_str, (node,))
470         else:
471             is_split = (type(node) in separate_nodes)
472             for nd in ast.iter_child_nodes(node):
473                 if type(nd) not in stopper_nodes:
474                     yield from extract_strings_ex(nd, is_split=is_split)
475
476     def _extract_string_merge(estr_ls, nds_ls):
477         return "".join(s for s in estr_ls if s is not None), tuple(n for n in nds_ls if n is not None)
478
479     def extract_strings(node):
480         estr_ls = []
481         nds_ls = []
482         for is_split, estr, nds in extract_strings_ex(node):
483             estr_ls.append(estr)
484             nds_ls.extend(nds)
485         ret = _extract_string_merge(estr_ls, nds_ls)
486         return ret
487
488     def extract_strings_split(node):
489         """
490         Returns a list args as returned by 'extract_strings()', but split into groups based on separate_nodes, this way
491         expressions like ("A" if test else "B") wont be merged but "A" + "B" will.
492         """
493         estr_ls = []
494         nds_ls = []
495         bag = []
496         for is_split, estr, nds in extract_strings_ex(node):
497             if is_split:
498                 bag.append((estr_ls, nds_ls))
499                 estr_ls = []
500                 nds_ls = []
501
502             estr_ls.append(estr)
503             nds_ls.extend(nds)
504
505         bag.append((estr_ls, nds_ls))
506
507         return [_extract_string_merge(estr_ls, nds_ls) for estr_ls, nds_ls in bag]
508
509     i18n_ctxt_ids = {v for v in bpy.app.translations.contexts_C_to_py.values()}
510     def _ctxt_to_ctxt(node):
511         # We must try, to some extend, to get contexts from vars instead of only literal strings...
512         ctxt = extract_strings(node)[0]
513         if ctxt:
514             return ctxt
515         # Basically, we search for attributes matching py context names, for now.
516         # So non-literal contexts should be used that way:
517         #     i18n_ctxt = bpy.app.translations.contexts
518         #     foobar(text="Foo", text_ctxt=i18n_ctxt.id_object)
519         if type(node) == ast.Attribute:
520             if node.attr in i18n_ctxt_ids:
521                 #print(node, node.attr, getattr(i18n_contexts, node.attr))
522                 return getattr(i18n_contexts, node.attr)
523         return i18n_contexts.default
524
525     def _op_to_ctxt(node):
526         # Some smart coders like things like:
527         #    >>> row.operator("wm.addon_disable" if is_enabled else "wm.addon_enable", ...)
528         # We only take first arg into account here!
529         bag = extract_strings_split(node)
530         opname, _ = bag[0]
531         if not opname:
532             return i18n_contexts.default
533         op = bpy.ops
534         for n in opname.split('.'):
535             op = getattr(op, n)
536         try:
537             return op.get_rna().bl_rna.translation_context
538         except Exception as e:
539             default_op_context = i18n_contexts.operator_default
540             print("ERROR: ", str(e))
541             print("       Assuming default operator context '{}'".format(default_op_context))
542             return default_op_context
543
544     # Gather function names.
545     # In addition of UI func, also parse pgettext ones...
546     # Tuples of (module name, (short names, ...)).
547     pgettext_variants = (
548         ("pgettext", ("_",)),
549         ("pgettext_iface", ("iface_",)),
550         ("pgettext_tip", ("tip_",)),
551         ("pgettext_data", ("data_",)),
552     )
553     pgettext_variants_args = {"msgid": (0, {"msgctxt": 1})}
554
555     # key: msgid keywords.
556     # val: tuples of ((keywords,), context_getter_func) to get a context for that msgid.
557     #      Note: order is important, first one wins!
558     translate_kw = {
559         "text": ((("text_ctxt",), _ctxt_to_ctxt),
560                  (("operator",), _op_to_ctxt),
561                 ),
562         "msgid": ((("msgctxt",), _ctxt_to_ctxt),
563                  ),
564         "message": (),
565     }
566
567     context_kw_set = {}
568     for k, ctxts in translate_kw.items():
569         s = set()
570         for c, _ in ctxts:
571             s |= set(c)
572         context_kw_set[k] = s
573
574     # {func_id: {msgid: (arg_pos,
575     #                    {msgctxt: arg_pos,
576     #                     ...
577     #                    }
578     #                   ),
579     #            ...
580     #           },
581     #  ...
582     # }
583     func_translate_args = {}
584
585     # First, functions from UILayout
586     # First loop is for msgid args, second one is for msgctxt args.
587     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
588         # check it has one or more arguments as defined in translate_kw
589         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
590             if ((arg_kw in translate_kw) and (not arg.is_output) and (arg.type == 'STRING')):
591                 func_translate_args.setdefault(func_id, {})[arg_kw] = (arg_pos, {})
592     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
593         if func_id not in func_translate_args:
594             continue
595         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
596             if (not arg.is_output) and (arg.type == 'STRING'):
597                 for msgid, msgctxts in context_kw_set.items():
598                     if arg_kw in msgctxts:
599                         func_translate_args[func_id][msgid][1][arg_kw] = arg_pos
600     # The report() func of operators.
601     for func_id, func in bpy.types.Operator.bl_rna.functions.items():
602         # check it has one or more arguments as defined in translate_kw
603         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
604             if ((arg_kw in translate_kw) and (not arg.is_output) and (arg.type == 'STRING')):
605                 func_translate_args.setdefault(func_id, {})[arg_kw] = (arg_pos, {})
606     # We manually add funcs from bpy.app.translations
607     for func_id, func_ids in pgettext_variants:
608         func_translate_args[func_id] = pgettext_variants_args
609         for func_id in func_ids:
610             func_translate_args[func_id] = pgettext_variants_args
611     #print(func_translate_args)
612
613     # Break recursive nodes look up on some kind of nodes.
614     # E.g. we don't want to get strings inside subscripts (blah["foo"])!
615     #      we don't want to get strings from comparisons (foo.type == 'BAR').
616     stopper_nodes = {ast.Subscript, ast.Compare}
617     # Consider strings separate: ("a" if test else "b")
618     separate_nodes = {ast.IfExp}
619
620     check_ctxt_py = None
621     if reports["check_ctxt"]:
622         check_ctxt = reports["check_ctxt"]
623         check_ctxt_py = {
624             "py_in_rna": (check_ctxt.get("py_in_rna"), set(msgs.keys())),
625             "multi_lines": check_ctxt.get("multi_lines"),
626             "not_capitalized": check_ctxt.get("not_capitalized"),
627             "end_point": check_ctxt.get("end_point"),
628             "spell_checker": check_ctxt.get("spell_checker"),
629             "spell_errors": check_ctxt.get("spell_errors"),
630         }
631
632     for fp in files:
633         with open(fp, 'r', encoding="utf8") as filedata:
634             root_node = ast.parse(filedata.read(), fp, 'exec')
635
636         fp_rel = make_rel(fp)
637
638         for node in ast.walk(root_node):
639             if type(node) == ast.Call:
640                 # print("found function at")
641                 # print("%s:%d" % (fp, node.lineno))
642
643                 # We can't skip such situations! from blah import foo\nfoo("bar") would also be an ast.Name func!
644                 if type(node.func) == ast.Name:
645                     func_id = node.func.id
646                 elif hasattr(node.func, "attr"):
647                     func_id = node.func.attr
648                 # Ugly things like getattr(self, con.type)(context, box, con)
649                 else:
650                     continue
651
652                 func_args = func_translate_args.get(func_id, {})
653
654                 # First try to get i18n contexts, for every possible msgid id.
655                 msgctxts = dict.fromkeys(func_args.keys(), "")
656                 for msgid, (_, context_args) in func_args.items():
657                     context_elements = {}
658                     for arg_kw, arg_pos in context_args.items():
659                         if arg_pos < len(node.args):
660                             context_elements[arg_kw] = node.args[arg_pos]
661                         else:
662                             for kw in node.keywords:
663                                 if kw.arg == arg_kw:
664                                     context_elements[arg_kw] = kw.value
665                                     break
666                     #print(context_elements)
667                     for kws, proc in translate_kw[msgid]:
668                         if set(kws) <= context_elements.keys():
669                             args = tuple(context_elements[k] for k in kws)
670                             #print("running ", proc, " with ", args)
671                             ctxt = proc(*args)
672                             if ctxt:
673                                 msgctxts[msgid] = ctxt
674                                 break
675
676                 #print(translate_args)
677                 # do nothing if not found
678                 for arg_kw, (arg_pos, _) in func_args.items():
679                     msgctxt = msgctxts[arg_kw]
680                     estr_lst = [(None, ())]
681                     if arg_pos < len(node.args):
682                         estr_lst = extract_strings_split(node.args[arg_pos])
683                         #print(estr, nds)
684                     else:
685                         for kw in node.keywords:
686                             if kw.arg == arg_kw:
687                                 estr_lst = extract_strings_split(kw.value)
688                                 break
689                         #print(estr, nds)
690                     for estr, nds in estr_lst:
691                         if estr:
692                             if nds:
693                                 msgsrc = "{}:{}".format(fp_rel, sorted({nd.lineno for nd in nds})[0])
694                             else:
695                                 msgsrc = "{}:???".format(fp_rel)
696                             process_msg(msgs, msgctxt, estr, msgsrc, reports, check_ctxt_py, settings)
697                             reports["py_messages"].append((msgctxt, estr, msgsrc))
698
699
700 def dump_py_messages(msgs, reports, addons, settings, addons_only=False):
701     def _get_files(path):
702         if not os.path.exists(path):
703             return []
704         if os.path.isdir(path):
705             return [os.path.join(dpath, fn) for dpath, _, fnames in os.walk(path) for fn in fnames
706                                             if not fn.startswith("_") and fn.endswith(".py")]
707         return [path]
708
709     files = []
710     if not addons_only:
711         for path in settings.CUSTOM_PY_UI_FILES:
712             for root in (bpy.utils.resource_path(t) for t in ('USER', 'LOCAL', 'SYSTEM')):
713                 files += _get_files(os.path.join(root, path))
714
715     # Add all given addons.
716     for mod in addons:
717         fn = mod.__file__
718         if os.path.basename(fn) == "__init__.py":
719             files += _get_files(os.path.dirname(fn))
720         else:
721             files.append(fn)
722
723     dump_py_messages_from_files(msgs, reports, sorted(files), settings)
724
725
726 ##### C source code #####
727 def dump_src_messages(msgs, reports, settings):
728     def get_contexts():
729         """Return a mapping {C_CTXT_NAME: ctxt_value}."""
730         return {k: getattr(bpy.app.translations.contexts, n) for k, n in bpy.app.translations.contexts_C_to_py.items()}
731
732     contexts = get_contexts()
733
734     # Build regexes to extract messages (with optional contexts) from C source.
735     pygettexts = tuple(re.compile(r).search for r in settings.PYGETTEXT_KEYWORDS)
736
737     _clean_str = re.compile(settings.str_clean_re).finditer
738     clean_str = lambda s: "".join(m.group("clean") for m in _clean_str(s))
739
740     def dump_src_file(path, rel_path, msgs, reports, settings):
741         def process_entry(_msgctxt, _msgid):
742             # Context.
743             msgctxt = settings.DEFAULT_CONTEXT
744             if _msgctxt:
745                 if _msgctxt in contexts:
746                     msgctxt = contexts[_msgctxt]
747                 elif '"' in _msgctxt or "'" in _msgctxt:
748                     msgctxt = clean_str(_msgctxt)
749                 else:
750                     print("WARNING: raw context “{}” couldn’t be resolved!".format(_msgctxt))
751             # Message.
752             msgid = ""
753             if _msgid:
754                 if '"' in _msgid or "'" in _msgid:
755                     msgid = clean_str(_msgid)
756                 else:
757                     print("WARNING: raw message “{}” couldn’t be resolved!".format(_msgid))
758             return msgctxt, msgid
759
760         check_ctxt_src = None
761         if reports["check_ctxt"]:
762             check_ctxt = reports["check_ctxt"]
763             check_ctxt_src = {
764                 "multi_lines": check_ctxt.get("multi_lines"),
765                 "not_capitalized": check_ctxt.get("not_capitalized"),
766                 "end_point": check_ctxt.get("end_point"),
767                 "spell_checker": check_ctxt.get("spell_checker"),
768                 "spell_errors": check_ctxt.get("spell_errors"),
769             }
770
771         data = ""
772         with open(path) as f:
773             data = f.read()
774         for srch in pygettexts:
775             m = srch(data)
776             line = pos = 0
777             while m:
778                 d = m.groupdict()
779                 # Line.
780                 line += data[pos:m.start()].count('\n')
781                 msgsrc = rel_path + ":" + str(line)
782                 _msgid = d.get("msg_raw")
783                 # First, try the "multi-contexts" stuff!
784                 _msgctxts = tuple(d.get("ctxt_raw{}".format(i)) for i in range(settings.PYGETTEXT_MAX_MULTI_CTXT))
785                 if _msgctxts[0]:
786                     for _msgctxt in _msgctxts:
787                         if not _msgctxt:
788                             break
789                         msgctxt, msgid = process_entry(_msgctxt, _msgid)
790                         process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt_src, settings)
791                         reports["src_messages"].append((msgctxt, msgid, msgsrc))
792                 else:
793                     _msgctxt = d.get("ctxt_raw")
794                     msgctxt, msgid = process_entry(_msgctxt, _msgid)
795                     process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt_src, settings)
796                     reports["src_messages"].append((msgctxt, msgid, msgsrc))
797
798                 pos = m.end()
799                 line += data[m.start():pos].count('\n')
800                 m = srch(data, pos)
801
802     forbidden = set()
803     forced = set()
804     if os.path.isfile(settings.SRC_POTFILES):
805         with open(settings.SRC_POTFILES) as src:
806             for l in src:
807                 if l[0] == '-':
808                     forbidden.add(l[1:].rstrip('\n'))
809                 elif l[0] != '#':
810                     forced.add(l.rstrip('\n'))
811     for root, dirs, files in os.walk(settings.POTFILES_SOURCE_DIR):
812         if "/.svn" in root:
813             continue
814         for fname in files:
815             if os.path.splitext(fname)[1] not in settings.PYGETTEXT_ALLOWED_EXTS:
816                 continue
817             path = os.path.join(root, fname)
818             try:  # can't always find the relative path (between drive letters on windows)
819                 rel_path = os.path.relpath(path, settings.SOURCE_DIR)
820             except ValueError:
821                 rel_path = path
822             if rel_path in forbidden:
823                 continue
824             elif rel_path not in forced:
825                 forced.add(rel_path)
826     for rel_path in sorted(forced):
827         path = os.path.join(settings.SOURCE_DIR, rel_path)
828         if os.path.exists(path):
829             dump_src_file(path, rel_path, msgs, reports, settings)
830
831
832 ##### Main functions! #####
833 def dump_messages(do_messages, do_checks, settings):
834     bl_ver = "Blender " + bpy.app.version_string
835     bl_hash = bpy.app.build_hash
836     bl_date = datetime.datetime.strptime(bpy.app.build_date.decode() + "T" + bpy.app.build_time.decode(),
837                                          "%Y-%m-%dT%H:%M:%S")
838     pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, bl_ver, bl_hash, bl_date, bl_date.year,
839                                                 settings=settings)
840     msgs = pot.msgs
841
842     # Enable all wanted addons.
843     # For now, enable all official addons, before extracting msgids.
844     addons = utils.enable_addons(support={"OFFICIAL"})
845     # Note this is not needed if we have been started with factory settings, but just in case...
846     utils.enable_addons(support={"COMMUNITY", "TESTING"}, disable=True)
847
848     reports = _gen_reports(_gen_check_ctxt(settings) if do_checks else None)
849
850     # Get strings from RNA.
851     dump_rna_messages(msgs, reports, settings)
852
853     # Get strings from UI layout definitions text="..." args.
854     dump_py_messages(msgs, reports, addons, settings)
855
856     # Get strings from C source code.
857     dump_src_messages(msgs, reports, settings)
858
859     # Get strings from addons' categories.
860     for uid, label, tip in bpy.types.WindowManager.addon_filter[1]['items'](bpy.context.window_manager, bpy.context):
861         process_msg(msgs, settings.DEFAULT_CONTEXT, label, "Add-ons' categories", reports, None, settings)
862         if tip:
863             process_msg(msgs, settings.DEFAULT_CONTEXT, tip, "Add-ons' categories", reports, None, settings)
864
865     # Get strings specific to translations' menu.
866     for lng in settings.LANGUAGES:
867         process_msg(msgs, settings.DEFAULT_CONTEXT, lng[1], "Languages’ labels from bl_i18n_utils/settings.py",
868                     reports, None, settings)
869     for cat in settings.LANGUAGES_CATEGORIES:
870         process_msg(msgs, settings.DEFAULT_CONTEXT, cat[1],
871                     "Language categories’ labels from bl_i18n_utils/settings.py", reports, None, settings)
872
873     #pot.check()
874     pot.unescape()  # Strings gathered in py/C source code may contain escaped chars...
875     print_info(reports, pot)
876     #pot.check()
877
878     if do_messages:
879         print("Writing messages…")
880         pot.write('PO', settings.FILE_NAME_POT)
881
882     print("Finished extracting UI messages!")
883
884     return pot  # Not used currently, but may be useful later (and to be consistent with dump_addon_messages!).
885
886
887 def dump_addon_messages(module_name, do_checks, settings):
888     import addon_utils
889
890     # Get current addon state (loaded or not):
891     was_loaded = addon_utils.check(module_name)[1]
892
893     # Enable our addon.
894     addon = utils.enable_addons(addons={module_name})[0]
895
896     addon_info = addon_utils.module_bl_info(addon)
897     ver = addon_info["name"] + " " + ".".join(str(v) for v in addon_info["version"])
898     rev = 0
899     date = datetime.datetime.now()
900     pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, ver, rev, date, date.year,
901                                                 settings=settings)
902     msgs = pot.msgs
903
904     minus_pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, ver, rev, date, date.year,
905                                                       settings=settings)
906     minus_msgs = minus_pot.msgs
907
908     check_ctxt = _gen_check_ctxt(settings) if do_checks else None
909     minus_check_ctxt = _gen_check_ctxt(settings) if do_checks else None
910
911     # Get strings from RNA, our addon being enabled.
912     print("A")
913     reports = _gen_reports(check_ctxt)
914     print("B")
915     dump_rna_messages(msgs, reports, settings)
916     print("C")
917
918     # Now disable our addon, and rescan RNA.
919     utils.enable_addons(addons={module_name}, disable=True)
920     print("D")
921     reports["check_ctxt"] = minus_check_ctxt
922     print("E")
923     dump_rna_messages(minus_msgs, reports, settings)
924     print("F")
925
926     # Restore previous state if needed!
927     if was_loaded:
928         utils.enable_addons(addons={module_name})
929
930     # and make the diff!
931     for key in minus_msgs:
932         if key != settings.PO_HEADER_KEY:
933             del msgs[key]
934
935     if check_ctxt:
936         _diff_check_ctxt(check_ctxt, minus_check_ctxt)
937
938     # and we are done with those!
939     del minus_pot
940     del minus_msgs
941     del minus_check_ctxt
942
943     # get strings from UI layout definitions text="..." args
944     reports["check_ctxt"] = check_ctxt
945     dump_py_messages(msgs, reports, {addon}, settings, addons_only=True)
946
947     pot.unescape()  # Strings gathered in py/C source code may contain escaped chars...
948     print_info(reports, pot)
949
950     print("Finished extracting UI messages!")
951
952     return pot
953
954
955 def main():
956     try:
957         import bpy
958     except ImportError:
959         print("This script must run from inside blender")
960         return
961
962     import sys
963     import argparse
964
965     # Get rid of Blender args!
966     argv = sys.argv[sys.argv.index("--") + 1:] if "--" in sys.argv else []
967
968     parser = argparse.ArgumentParser(description="Process UI messages from inside Blender.")
969     parser.add_argument('-c', '--no_checks', default=True, action="store_false", help="No checks over UI messages.")
970     parser.add_argument('-m', '--no_messages', default=True, action="store_false", help="No export of UI messages.")
971     parser.add_argument('-o', '--output', default=None, help="Output POT file path.")
972     parser.add_argument('-s', '--settings', default=None,
973                         help="Override (some) default settings. Either a JSon file name, or a JSon string.")
974     args = parser.parse_args(argv)
975
976     settings = settings_i18n.I18nSettings()
977     settings.from_json(args.settings)
978
979     if args.output:
980         settings.FILE_NAME_POT = args.output
981
982     dump_messages(do_messages=args.no_messages, do_checks=args.no_checks, settings=settings)
983
984
985 if __name__ == "__main__":
986     print("\n\n *** Running {} *** \n".format(__file__))
987     main()