Fix broken i18n messages extracting script with new py code.
[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         for cls in _rna:
234             for prop in cls.bl_rna.properties:
235                 if prop.type == 'COLLECTION':
236                     prop_cls = prop.srna
237                     if prop_cls is not None:
238                         blacklist_rna_class.add(prop_cls.__class__)
239
240         # Now here is the *ugly* hack!
241         # Unfortunately, all classes we want to access are not available from bpy.types (OperatorProperties subclasses
242         # are not here, as they have the same name as matching Operator ones :( ). So we use __subclasses__() calls
243         # to walk through all rna hierachy.
244         # But unregistered classes remain listed by relevant __subclasses__() calls (be it a Py or BPY/RNA bug),
245         # and obviously the matching RNA struct exists no more, so trying to access their data (even the identifier)
246         # quickly leads to segfault!
247         # To address this, we have to blacklist classes which __name__ does not match any __name__ from bpy.types
248         # (we can't use only RNA identifiers, as some py-defined classes has a different name that rna id,
249         # and we can't use class object themselves, because OperatorProperties subclasses are not in bpy.types!)...
250
251         _rna_clss_ids = {cls.__name__ for cls in _rna} | {cls.bl_rna.identifier for cls in _rna}
252
253         # All registrable types.
254         blacklist_rna_class |= {cls for cls in bpy.types.OperatorProperties.__subclasses__() +
255                                                bpy.types.Operator.__subclasses__() +
256                                                bpy.types.OperatorMacro.__subclasses__() +
257                                                bpy.types.Header.__subclasses__() +
258                                                bpy.types.Panel.__subclasses__() +
259                                                bpy.types.Menu.__subclasses__() +
260                                                bpy.types.UIList.__subclasses__()
261                                     if cls.__name__ not in _rna_clss_ids}
262
263         # Collect internal operators
264         # extend with all internal operators
265         # note that this uses internal api introspection functions
266         # XXX Do not skip INTERNAL's anymore, some of those ops show up in UI now!
267         # all possible operator names
268         #op_ids = (set(cls.bl_rna.identifier for cls in bpy.types.OperatorProperties.__subclasses__()) |
269         #          set(cls.bl_rna.identifier for cls in bpy.types.Operator.__subclasses__()) |
270         #          set(cls.bl_rna.identifier for cls in bpy.types.OperatorMacro.__subclasses__()))
271
272         #get_instance = __import__("_bpy").ops.get_instance
273         #path_resolve = type(bpy.context).__base__.path_resolve
274         #for idname in op_ids:
275             #op = get_instance(idname)
276             #if 'INTERNAL' in path_resolve(op, "bl_options"):
277                 #blacklist_rna_class.add(idname)
278
279         return blacklist_rna_class
280
281     check_ctxt_rna = check_ctxt_rna_tip = None
282     check_ctxt = reports["check_ctxt"]
283     if check_ctxt:
284         check_ctxt_rna = {
285             "multi_lines": check_ctxt.get("multi_lines"),
286             "not_capitalized": check_ctxt.get("not_capitalized"),
287             "end_point": check_ctxt.get("end_point"),
288             "undoc_ops": check_ctxt.get("undoc_ops"),
289             "spell_checker": check_ctxt.get("spell_checker"),
290             "spell_errors": check_ctxt.get("spell_errors"),
291         }
292         check_ctxt_rna_tip = check_ctxt_rna
293         check_ctxt_rna_tip["multi_rnatip"] = check_ctxt.get("multi_rnatip")
294
295     default_context = settings.DEFAULT_CONTEXT
296
297     # Function definitions
298     def walk_properties(cls):
299         bl_rna = cls.bl_rna
300         # Get our parents' properties, to not export them multiple times.
301         bl_rna_base = bl_rna.base
302         if bl_rna_base:
303             bl_rna_base_props = set(bl_rna_base.properties.values())
304         else:
305             bl_rna_base_props = set()
306
307         props = sorted(bl_rna.properties, key=lambda p: p.identifier)
308         for prop in props:
309             # Only write this property if our parent hasn't got it.
310             if prop in bl_rna_base_props:
311                 continue
312             if prop.identifier == "rna_type":
313                 continue
314             reports["rna_props"].append((cls, prop))
315
316             msgsrc = "bpy.types.{}.{}".format(bl_rna.identifier, prop.identifier)
317             msgctxt = prop.translation_context or default_context
318
319             if prop.name and (prop.name != prop.identifier or msgctxt != default_context):
320                 process_msg(msgs, msgctxt, prop.name, msgsrc, reports, check_ctxt_rna, settings)
321             if prop.description:
322                 process_msg(msgs, default_context, prop.description, msgsrc, reports, check_ctxt_rna_tip, settings)
323
324             if isinstance(prop, bpy.types.EnumProperty):
325                 for item in prop.enum_items:
326                     msgsrc = "bpy.types.{}.{}:'{}'".format(bl_rna.identifier, prop.identifier, item.identifier)
327                     if item.name and item.name != item.identifier:
328                         process_msg(msgs, msgctxt, item.name, msgsrc, reports, check_ctxt_rna, settings)
329                     if item.description:
330                         process_msg(msgs, default_context, item.description, msgsrc, reports, check_ctxt_rna_tip,
331                                     settings)
332
333     blacklist_rna_class = class_blacklist()
334
335     def walk_class(cls):
336         bl_rna = cls.bl_rna
337         msgsrc = "bpy.types." + bl_rna.identifier
338         msgctxt = bl_rna.translation_context or default_context
339
340         if bl_rna.name and (bl_rna.name != bl_rna.identifier or msgctxt != default_context):
341             process_msg(msgs, msgctxt, bl_rna.name, msgsrc, reports, check_ctxt_rna, settings)
342
343         if bl_rna.description:
344             process_msg(msgs, default_context, bl_rna.description, msgsrc, reports, check_ctxt_rna_tip, settings)
345         elif cls.__doc__:  # XXX Some classes (like KeyingSetInfo subclasses) have void description... :(
346             process_msg(msgs, default_context, cls.__doc__, msgsrc, reports, check_ctxt_rna_tip, settings)
347
348         # Panels' "tabs" system.
349         if hasattr(bl_rna, 'bl_category') and bl_rna.bl_category:
350             process_msg(msgs, default_context, bl_rna.bl_category, msgsrc, reports, check_ctxt_rna, settings)
351
352         if hasattr(bl_rna, 'bl_label') and bl_rna.bl_label:
353             process_msg(msgs, msgctxt, bl_rna.bl_label, msgsrc, reports, check_ctxt_rna, settings)
354
355         walk_properties(cls)
356
357     def walk_keymap_hierarchy(hier, msgsrc_prev):
358         km_i18n_context = bpy.app.translations.contexts.id_windowmanager
359         for lvl in hier:
360             msgsrc = msgsrc_prev + "." + lvl[1]
361             process_msg(msgs, km_i18n_context, lvl[0], msgsrc, reports, None, settings)
362             if lvl[3]:
363                 walk_keymap_hierarchy(lvl[3], msgsrc)
364
365     # Dump Messages
366     def process_cls_list(cls_list):
367         if not cls_list:
368             return
369
370         def full_class_id(cls):
371             """Gives us 'ID.Lamp.AreaLamp' which is best for sorting."""
372             # Always the same issue, some classes listed in blacklist should actually no more exist (they have been
373             # unregistered), but are still listed by __subclasses__() calls... :/
374             if cls in blacklist_rna_class:
375                 return cls.__name__
376             cls_id = ""
377             bl_rna = cls.bl_rna
378             while bl_rna:
379                 cls_id = bl_rna.identifier + "." + cls_id
380                 bl_rna = bl_rna.base
381             return cls_id
382         if verbose:
383             print(cls_list)
384         cls_list.sort(key=full_class_id)
385         for cls in cls_list:
386             if verbose:
387                 print(cls)
388             reports["rna_structs"].append(cls)
389             # Ignore those Operator sub-classes (anyway, will get the same from OperatorProperties sub-classes!)...
390             if (cls in blacklist_rna_class) or issubclass(cls, bpy.types.Operator):
391                 reports["rna_structs_skipped"].append(cls)
392             else:
393                 walk_class(cls)
394             # Recursively process subclasses.
395             process_cls_list(cls.__subclasses__())
396
397     # Parse everything (recursively parsing from bpy_struct "class"...).
398     process_cls_list(bpy.types.ID.__base__.__subclasses__())
399
400     # And parse keymaps!
401     from bpy_extras.keyconfig_utils import KM_HIERARCHY
402     walk_keymap_hierarchy(KM_HIERARCHY, "KM_HIERARCHY")
403
404
405 ##### Python source code #####
406 def dump_py_messages_from_files(msgs, reports, files, settings):
407     """
408     Dump text inlined in the python files given, e.g. 'My Name' in:
409         layout.prop("someprop", text="My Name")
410     """
411     import ast
412
413     bpy_struct = bpy.types.ID.__base__
414     i18n_contexts = bpy.app.translations.contexts
415
416     root_paths = tuple(bpy.utils.resource_path(t) for t in ('USER', 'LOCAL', 'SYSTEM'))
417     def make_rel(path):
418         for rp in root_paths:
419             if path.startswith(rp):
420                 try:  # can't always find the relative path (between drive letters on windows)
421                     return os.path.relpath(path, rp)
422                 except ValueError:
423                     return path
424         # Use binary's dir as fallback...
425         try:  # can't always find the relative path (between drive letters on windows)
426             return os.path.relpath(path, os.path.dirname(bpy.app.binary_path))
427         except ValueError:
428             return path
429
430     # Helper function
431     def extract_strings_ex(node, is_split=False):
432         """
433         Recursively get strings, needed in case we have "Blah" + "Blah", passed as an argument in that case it won't
434         evaluate to a string. However, break on some kind of stopper nodes, like e.g. Subscript.
435         """
436         if type(node) == ast.Str:
437             eval_str = ast.literal_eval(node)
438             if eval_str:
439                 yield (is_split, eval_str, (node,))
440         else:
441             is_split = (type(node) in separate_nodes)
442             for nd in ast.iter_child_nodes(node):
443                 if type(nd) not in stopper_nodes:
444                     yield from extract_strings_ex(nd, is_split=is_split)
445
446     def _extract_string_merge(estr_ls, nds_ls):
447         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)
448
449     def extract_strings(node):
450         estr_ls = []
451         nds_ls = []
452         for is_split, estr, nds in extract_strings_ex(node):
453             estr_ls.append(estr)
454             nds_ls.extend(nds)
455         ret = _extract_string_merge(estr_ls, nds_ls)
456         return ret
457
458     def extract_strings_split(node):
459         """
460         Returns a list args as returned by 'extract_strings()', but split into groups based on separate_nodes, this way
461         expressions like ("A" if test else "B") wont be merged but "A" + "B" will.
462         """
463         estr_ls = []
464         nds_ls = []
465         bag = []
466         for is_split, estr, nds in extract_strings_ex(node):
467             if is_split:
468                 bag.append((estr_ls, nds_ls))
469                 estr_ls = []
470                 nds_ls = []
471
472             estr_ls.append(estr)
473             nds_ls.extend(nds)
474
475         bag.append((estr_ls, nds_ls))
476
477         return [_extract_string_merge(estr_ls, nds_ls) for estr_ls, nds_ls in bag]
478
479     i18n_ctxt_ids = {v for v in bpy.app.translations.contexts_C_to_py.values()}
480     def _ctxt_to_ctxt(node):
481         # We must try, to some extend, to get contexts from vars instead of only literal strings...
482         ctxt = extract_strings(node)[0]
483         if ctxt:
484             return ctxt
485         # Basically, we search for attributes matching py context names, for now.
486         # So non-literal contexts should be used that way:
487         #     i18n_ctxt = bpy.app.translations.contexts
488         #     foobar(text="Foo", text_ctxt=i18n_ctxt.id_object)
489         if type(node) == ast.Attribute:
490             if node.attr in i18n_ctxt_ids:
491                 #print(node, node.attr, getattr(i18n_contexts, node.attr))
492                 return getattr(i18n_contexts, node.attr)
493         return i18n_contexts.default
494
495     def _op_to_ctxt(node):
496         # Some smart coders like things like:
497         #    >>> row.operator("wm.addon_disable" if is_enabled else "wm.addon_enable", ...)
498         # We only take first arg into account here!
499         bag = extract_strings_split(node)
500         opname, _ = bag[0]
501         if not opname:
502             return i18n_contexts.default
503         op = bpy.ops
504         for n in opname.split('.'):
505             op = getattr(op, n)
506         try:
507             return op.get_rna().bl_rna.translation_context
508         except Exception as e:
509             default_op_context = i18n_contexts.operator_default
510             print("ERROR: ", str(e))
511             print("       Assuming default operator context '{}'".format(default_op_context))
512             return default_op_context
513
514     # Gather function names.
515     # In addition of UI func, also parse pgettext ones...
516     # Tuples of (module name, (short names, ...)).
517     pgettext_variants = (
518         ("pgettext", ("_",)),
519         ("pgettext_iface", ("iface_",)),
520         ("pgettext_tip", ("tip_",)),
521         ("pgettext_data", ("data_",)),
522     )
523     pgettext_variants_args = {"msgid": (0, {"msgctxt": 1})}
524
525     # key: msgid keywords.
526     # val: tuples of ((keywords,), context_getter_func) to get a context for that msgid.
527     #      Note: order is important, first one wins!
528     translate_kw = {
529         "text": ((("text_ctxt",), _ctxt_to_ctxt),
530                  (("operator",), _op_to_ctxt),
531                 ),
532         "msgid": ((("msgctxt",), _ctxt_to_ctxt),
533                  ),
534         "message": (),
535     }
536
537     context_kw_set = {}
538     for k, ctxts in translate_kw.items():
539         s = set()
540         for c, _ in ctxts:
541             s |= set(c)
542         context_kw_set[k] = s
543
544     # {func_id: {msgid: (arg_pos,
545     #                    {msgctxt: arg_pos,
546     #                     ...
547     #                    }
548     #                   ),
549     #            ...
550     #           },
551     #  ...
552     # }
553     func_translate_args = {}
554
555     # First, functions from UILayout
556     # First loop is for msgid args, second one is for msgctxt args.
557     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
558         # check it has one or more arguments as defined in translate_kw
559         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
560             if ((arg_kw in translate_kw) and (not arg.is_output) and (arg.type == 'STRING')):
561                 func_translate_args.setdefault(func_id, {})[arg_kw] = (arg_pos, {})
562     for func_id, func in bpy.types.UILayout.bl_rna.functions.items():
563         if func_id not in func_translate_args:
564             continue
565         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
566             if (not arg.is_output) and (arg.type == 'STRING'):
567                 for msgid, msgctxts in context_kw_set.items():
568                     if arg_kw in msgctxts:
569                         func_translate_args[func_id][msgid][1][arg_kw] = arg_pos
570     # The report() func of operators.
571     for func_id, func in bpy.types.Operator.bl_rna.functions.items():
572         # check it has one or more arguments as defined in translate_kw
573         for arg_pos, (arg_kw, arg) in enumerate(func.parameters.items()):
574             if ((arg_kw in translate_kw) and (not arg.is_output) and (arg.type == 'STRING')):
575                 func_translate_args.setdefault(func_id, {})[arg_kw] = (arg_pos, {})
576     # We manually add funcs from bpy.app.translations
577     for func_id, func_ids in pgettext_variants:
578         func_translate_args[func_id] = pgettext_variants_args
579         for func_id in func_ids:
580             func_translate_args[func_id] = pgettext_variants_args
581     #print(func_translate_args)
582
583     # Break recursive nodes look up on some kind of nodes.
584     # E.g. we don't want to get strings inside subscripts (blah["foo"])!
585     #      we don't want to get strings from comparisons (foo.type == 'BAR').
586     stopper_nodes = {ast.Subscript, ast.Compare}
587     # Consider strings separate: ("a" if test else "b")
588     separate_nodes = {ast.IfExp}
589
590     check_ctxt_py = None
591     if reports["check_ctxt"]:
592         check_ctxt = reports["check_ctxt"]
593         check_ctxt_py = {
594             "py_in_rna": (check_ctxt.get("py_in_rna"), set(msgs.keys())),
595             "multi_lines": check_ctxt.get("multi_lines"),
596             "not_capitalized": check_ctxt.get("not_capitalized"),
597             "end_point": check_ctxt.get("end_point"),
598             "spell_checker": check_ctxt.get("spell_checker"),
599             "spell_errors": check_ctxt.get("spell_errors"),
600         }
601
602     for fp in files:
603         with open(fp, 'r', encoding="utf8") as filedata:
604             root_node = ast.parse(filedata.read(), fp, 'exec')
605
606         fp_rel = make_rel(fp)
607
608         for node in ast.walk(root_node):
609             if type(node) == ast.Call:
610                 # print("found function at")
611                 # print("%s:%d" % (fp, node.lineno))
612
613                 # We can't skip such situations! from blah import foo\nfoo("bar") would also be an ast.Name func!
614                 if type(node.func) == ast.Name:
615                     func_id = node.func.id
616                 elif hasattr(node.func, "attr"):
617                     func_id = node.func.attr
618                 # Ugly things like getattr(self, con.type)(context, box, con)
619                 else:
620                     continue
621
622                 func_args = func_translate_args.get(func_id, {})
623
624                 # First try to get i18n contexts, for every possible msgid id.
625                 msgctxts = dict.fromkeys(func_args.keys(), "")
626                 for msgid, (_, context_args) in func_args.items():
627                     context_elements = {}
628                     for arg_kw, arg_pos in context_args.items():
629                         if arg_pos < len(node.args):
630                             context_elements[arg_kw] = node.args[arg_pos]
631                         else:
632                             for kw in node.keywords:
633                                 if kw.arg == arg_kw:
634                                     context_elements[arg_kw] = kw.value
635                                     break
636                     #print(context_elements)
637                     for kws, proc in translate_kw[msgid]:
638                         if set(kws) <= context_elements.keys():
639                             args = tuple(context_elements[k] for k in kws)
640                             #print("running ", proc, " with ", args)
641                             ctxt = proc(*args)
642                             if ctxt:
643                                 msgctxts[msgid] = ctxt
644                                 break
645
646                 #print(translate_args)
647                 # do nothing if not found
648                 for arg_kw, (arg_pos, _) in func_args.items():
649                     msgctxt = msgctxts[arg_kw]
650                     estr_lst = [(None, ())]
651                     if arg_pos < len(node.args):
652                         estr_lst = extract_strings_split(node.args[arg_pos])
653                         #print(estr, nds)
654                     else:
655                         for kw in node.keywords:
656                             if kw.arg == arg_kw:
657                                 estr_lst = extract_strings_split(kw.value)
658                                 break
659                         #print(estr, nds)
660                     for estr, nds in estr_lst:
661                         if estr:
662                             if nds:
663                                 msgsrc = "{}:{}".format(fp_rel, sorted({nd.lineno for nd in nds})[0])
664                             else:
665                                 msgsrc = "{}:???".format(fp_rel)
666                             process_msg(msgs, msgctxt, estr, msgsrc, reports, check_ctxt_py, settings)
667                             reports["py_messages"].append((msgctxt, estr, msgsrc))
668
669
670 def dump_py_messages(msgs, reports, addons, settings, addons_only=False):
671     def _get_files(path):
672         if not os.path.exists(path):
673             return []
674         if os.path.isdir(path):
675             return [os.path.join(dpath, fn) for dpath, _, fnames in os.walk(path) for fn in fnames
676                                             if not fn.startswith("_") and fn.endswith(".py")]
677         return [path]
678
679     files = []
680     if not addons_only:
681         for path in settings.CUSTOM_PY_UI_FILES:
682             for root in (bpy.utils.resource_path(t) for t in ('USER', 'LOCAL', 'SYSTEM')):
683                 files += _get_files(os.path.join(root, path))
684
685     # Add all given addons.
686     for mod in addons:
687         fn = mod.__file__
688         if os.path.basename(fn) == "__init__.py":
689             files += _get_files(os.path.dirname(fn))
690         else:
691             files.append(fn)
692
693     dump_py_messages_from_files(msgs, reports, sorted(files), settings)
694
695
696 ##### C source code #####
697 def dump_src_messages(msgs, reports, settings):
698     def get_contexts():
699         """Return a mapping {C_CTXT_NAME: ctxt_value}."""
700         return {k: getattr(bpy.app.translations.contexts, n) for k, n in bpy.app.translations.contexts_C_to_py.items()}
701
702     contexts = get_contexts()
703
704     # Build regexes to extract messages (with optional contexts) from C source.
705     pygettexts = tuple(re.compile(r).search for r in settings.PYGETTEXT_KEYWORDS)
706
707     _clean_str = re.compile(settings.str_clean_re).finditer
708     clean_str = lambda s: "".join(m.group("clean") for m in _clean_str(s))
709
710     def dump_src_file(path, rel_path, msgs, reports, settings):
711         def process_entry(_msgctxt, _msgid):
712             # Context.
713             msgctxt = settings.DEFAULT_CONTEXT
714             if _msgctxt:
715                 if _msgctxt in contexts:
716                     msgctxt = contexts[_msgctxt]
717                 elif '"' in _msgctxt or "'" in _msgctxt:
718                     msgctxt = clean_str(_msgctxt)
719                 else:
720                     print("WARNING: raw context “{}” couldn’t be resolved!".format(_msgctxt))
721             # Message.
722             msgid = ""
723             if _msgid:
724                 if '"' in _msgid or "'" in _msgid:
725                     msgid = clean_str(_msgid)
726                 else:
727                     print("WARNING: raw message “{}” couldn’t be resolved!".format(_msgid))
728             return msgctxt, msgid
729
730         check_ctxt_src = None
731         if reports["check_ctxt"]:
732             check_ctxt = reports["check_ctxt"]
733             check_ctxt_src = {
734                 "multi_lines": check_ctxt.get("multi_lines"),
735                 "not_capitalized": check_ctxt.get("not_capitalized"),
736                 "end_point": check_ctxt.get("end_point"),
737                 "spell_checker": check_ctxt.get("spell_checker"),
738                 "spell_errors": check_ctxt.get("spell_errors"),
739             }
740
741         data = ""
742         with open(path) as f:
743             data = f.read()
744         for srch in pygettexts:
745             m = srch(data)
746             line = pos = 0
747             while m:
748                 d = m.groupdict()
749                 # Line.
750                 line += data[pos:m.start()].count('\n')
751                 msgsrc = rel_path + ":" + str(line)
752                 _msgid = d.get("msg_raw")
753                 # First, try the "multi-contexts" stuff!
754                 _msgctxts = tuple(d.get("ctxt_raw{}".format(i)) for i in range(settings.PYGETTEXT_MAX_MULTI_CTXT))
755                 if _msgctxts[0]:
756                     for _msgctxt in _msgctxts:
757                         if not _msgctxt:
758                             break
759                         msgctxt, msgid = process_entry(_msgctxt, _msgid)
760                         process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt_src, settings)
761                         reports["src_messages"].append((msgctxt, msgid, msgsrc))
762                 else:
763                     _msgctxt = d.get("ctxt_raw")
764                     msgctxt, msgid = process_entry(_msgctxt, _msgid)
765                     process_msg(msgs, msgctxt, msgid, msgsrc, reports, check_ctxt_src, settings)
766                     reports["src_messages"].append((msgctxt, msgid, msgsrc))
767
768                 pos = m.end()
769                 line += data[m.start():pos].count('\n')
770                 m = srch(data, pos)
771
772     forbidden = set()
773     forced = set()
774     if os.path.isfile(settings.SRC_POTFILES):
775         with open(settings.SRC_POTFILES) as src:
776             for l in src:
777                 if l[0] == '-':
778                     forbidden.add(l[1:].rstrip('\n'))
779                 elif l[0] != '#':
780                     forced.add(l.rstrip('\n'))
781     for root, dirs, files in os.walk(settings.POTFILES_SOURCE_DIR):
782         if "/.svn" in root:
783             continue
784         for fname in files:
785             if os.path.splitext(fname)[1] not in settings.PYGETTEXT_ALLOWED_EXTS:
786                 continue
787             path = os.path.join(root, fname)
788             try:  # can't always find the relative path (between drive letters on windows)
789                 rel_path = os.path.relpath(path, settings.SOURCE_DIR)
790             except ValueError:
791                 rel_path = path
792             if rel_path in forbidden:
793                 continue
794             elif rel_path not in forced:
795                 forced.add(rel_path)
796     for rel_path in sorted(forced):
797         path = os.path.join(settings.SOURCE_DIR, rel_path)
798         if os.path.exists(path):
799             dump_src_file(path, rel_path, msgs, reports, settings)
800
801
802 ##### Main functions! #####
803 def dump_messages(do_messages, do_checks, settings):
804     bl_ver = "Blender " + bpy.app.version_string
805     bl_hash = bpy.app.build_hash
806     bl_date = datetime.datetime.strptime(bpy.app.build_date.decode() + "T" + bpy.app.build_time.decode(),
807                                          "%Y-%m-%dT%H:%M:%S")
808     pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, bl_ver, bl_hash, bl_date, bl_date.year,
809                                                 settings=settings)
810     msgs = pot.msgs
811
812     # Enable all wanted addons.
813     # For now, enable all official addons, before extracting msgids.
814     addons = utils.enable_addons(support={"OFFICIAL"})
815     # Note this is not needed if we have been started with factory settings, but just in case...
816     utils.enable_addons(support={"COMMUNITY", "TESTING"}, disable=True)
817
818     reports = _gen_reports(_gen_check_ctxt(settings) if do_checks else None)
819
820     # Get strings from RNA.
821     dump_rna_messages(msgs, reports, settings)
822
823     # Get strings from UI layout definitions text="..." args.
824     dump_py_messages(msgs, reports, addons, settings)
825
826     # Get strings from C source code.
827     dump_src_messages(msgs, reports, settings)
828
829     # Get strings from addons' categories.
830     for uid, label, tip in bpy.types.WindowManager.addon_filter[1]['items'](bpy.context.window_manager, bpy.context):
831         process_msg(msgs, settings.DEFAULT_CONTEXT, label, "Add-ons' categories", reports, None, settings)
832         if tip:
833             process_msg(msgs, settings.DEFAULT_CONTEXT, tip, "Add-ons' categories", reports, None, settings)
834
835     # Get strings specific to translations' menu.
836     for lng in settings.LANGUAGES:
837         process_msg(msgs, settings.DEFAULT_CONTEXT, lng[1], "Languages’ labels from bl_i18n_utils/settings.py",
838                     reports, None, settings)
839     for cat in settings.LANGUAGES_CATEGORIES:
840         process_msg(msgs, settings.DEFAULT_CONTEXT, cat[1],
841                     "Language categories’ labels from bl_i18n_utils/settings.py", reports, None, settings)
842
843     #pot.check()
844     pot.unescape()  # Strings gathered in py/C source code may contain escaped chars...
845     print_info(reports, pot)
846     #pot.check()
847
848     if do_messages:
849         print("Writing messages…")
850         pot.write('PO', settings.FILE_NAME_POT)
851
852     print("Finished extracting UI messages!")
853
854     return pot  # Not used currently, but may be useful later (and to be consistent with dump_addon_messages!).
855
856
857 def dump_addon_messages(module_name, do_checks, settings):
858     import addon_utils
859
860     # Get current addon state (loaded or not):
861     was_loaded = addon_utils.check(module_name)[1]
862
863     # Enable our addon.
864     addon = utils.enable_addons(addons={module_name})[0]
865
866     addon_info = addon_utils.module_bl_info(addon)
867     ver = addon_info["name"] + " " + ".".join(str(v) for v in addon_info["version"])
868     rev = 0
869     date = datetime.datetime.now()
870     pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, ver, rev, date, date.year,
871                                                 settings=settings)
872     msgs = pot.msgs
873
874     minus_pot = utils.I18nMessages.gen_empty_messages(settings.PARSER_TEMPLATE_ID, ver, rev, date, date.year,
875                                                       settings=settings)
876     minus_msgs = minus_pot.msgs
877
878     check_ctxt = _gen_check_ctxt(settings) if do_checks else None
879     minus_check_ctxt = _gen_check_ctxt(settings) if do_checks else None
880
881     # Get strings from RNA, our addon being enabled.
882     print("A")
883     reports = _gen_reports(check_ctxt)
884     print("B")
885     dump_rna_messages(msgs, reports, settings)
886     print("C")
887
888     # Now disable our addon, and rescan RNA.
889     utils.enable_addons(addons={module_name}, disable=True)
890     print("D")
891     reports["check_ctxt"] = minus_check_ctxt
892     print("E")
893     dump_rna_messages(minus_msgs, reports, settings)
894     print("F")
895
896     # Restore previous state if needed!
897     if was_loaded:
898         utils.enable_addons(addons={module_name})
899
900     # and make the diff!
901     for key in minus_msgs:
902         if key != settings.PO_HEADER_KEY:
903             del msgs[key]
904
905     if check_ctxt:
906         _diff_check_ctxt(check_ctxt, minus_check_ctxt)
907
908     # and we are done with those!
909     del minus_pot
910     del minus_msgs
911     del minus_check_ctxt
912
913     # get strings from UI layout definitions text="..." args
914     reports["check_ctxt"] = check_ctxt
915     dump_py_messages(msgs, reports, {addon}, settings, addons_only=True)
916
917     pot.unescape()  # Strings gathered in py/C source code may contain escaped chars...
918     print_info(reports, pot)
919
920     print("Finished extracting UI messages!")
921
922     return pot
923
924
925 def main():
926     try:
927         import bpy
928     except ImportError:
929         print("This script must run from inside blender")
930         return
931
932     import sys
933     import argparse
934
935     # Get rid of Blender args!
936     argv = sys.argv[sys.argv.index("--") + 1:] if "--" in sys.argv else []
937
938     parser = argparse.ArgumentParser(description="Process UI messages from inside Blender.")
939     parser.add_argument('-c', '--no_checks', default=True, action="store_false", help="No checks over UI messages.")
940     parser.add_argument('-m', '--no_messages', default=True, action="store_false", help="No export of UI messages.")
941     parser.add_argument('-o', '--output', default=None, help="Output POT file path.")
942     parser.add_argument('-s', '--settings', default=None,
943                         help="Override (some) default settings. Either a JSon file name, or a JSon string.")
944     args = parser.parse_args(argv)
945
946     settings = settings_i18n.I18nSettings()
947     settings.from_json(args.settings)
948
949     if args.output:
950         settings.FILE_NAME_POT = args.output
951
952     dump_messages(do_messages=args.no_messages, do_checks=args.no_checks, settings=settings)
953
954
955 if __name__ == "__main__":
956     print("\n\n *** Running {} *** \n".format(__file__))
957     main()