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