psychopy 2025.1.0__py3-none-any.whl → 2025.2.1__py3-none-any.whl

psychopy/localization/generateTranslationTemplate.py

@@ -10,155 +10,247 @@
 import os
 import sys
 import subprocess
-import codecs
 import shutil
 import git
 import babel.messages.frontend
-import babel.messages.pofile
+import polib
 import argparse
 
 from psychopy import __version__ as psychopy_version
 
-#
-# commandline argument
-#
-
-parser = argparse.ArgumentParser(description='usage: generateTranslationTemplate.py [-h] [-c]')
-parser.add_argument('-c', '--commit', action='store_true', help='Commit messages.pot if updated.', required=False)
-
-command_args = parser.parse_args()
-
-#
-# hints.py must be updated to find new hints and alarts
-#
-
-print('Generate hints.py... ', end='')
-subprocess.call(['python', 'generateHints.py'], cwd='../preferences')
-print('Done.\nGenerate alartmsg.py... ', end='')
-subprocess.call(['python', 'generateAlertmsg.py'], cwd='../alerts/alertsCatalogue')
-print('Done.')
-
-#
-# Extracting messages and generating new template file
-#
-
-print('Generating new template file... ', end='')
+locale_dir = '../app/locale/'
 new_pot_filename = 'messages_new.pot'
 current_pot_filename = 'messages.pot'
-
-argv = ['pybabel', '-q', 'extract',
-        '--input-dirs=..',
-        '--project=PsychoPy',
-        '--version='+psychopy_version,
-        '-k', '_translate',
-        '-o', new_pot_filename]
-
 babel_frontend = babel.messages.frontend.CommandLineInterface()
-babel_frontend.run(argv)
-
-print('Done.')
 
-#
-# Comparing new and current pot file.
-#
+target_files = [
+    'psychopy/localization/messages.pot',
+    'psychopy/preferences/hints.py',
+    'psychopy/alerts/alertsCatalogue/alertmsg.py'
+]
+
+poedit_mime_headers = {
+    "X-Poedit-KeywordsList": "_translate",
+    "X-Poedit-Basepath": "../../../..", 
+    "X-Poedit-SourceCharset": "UTF-8",
+    "X-Poedit-SearchPath-0:": ".",
+    "X-Poedit-SearchPathExcluded-0": "app/localization/utils",
+    "X-Poedit-SearchPathExcluded-1": "app/Resources"
+}
+
+def generate_new_template(verbose=False):
+    """
+    Generate new POT file using pybabel.
+    Before running pybabel, generateHints.py and generateAlertmsg.py are called
+    to update lists of hints and alerts.
+    
+    Returns:
+        None
+    """
+
+    # hints.py must be updated to find new hints and alarts
+    if verbose:
+        print('Generate hints.py... ', end='')
+    subprocess.call(['python', 'generateHints.py'], cwd='../preferences')
+    if verbose:
+        print('Done.\nGenerate alartmsg.py... ', end='')
+    subprocess.call(['python', 'generateAlertmsg.py'], cwd='../alerts/alertsCatalogue')
+    if verbose:
+        print('Done.')
+
+    # Extracting messages and generating new template file
+
+    if verbose:
+        print('Generating new template file... ', end='')
+    argv = ['pybabel', '-q', 'extract',
+            '--input-dirs=.',
+            '--project=PsychoPy',
+            '--version='+psychopy_version,
+            '--keyword=_translate',
+            '--width=79',
+            '--output-file=localization/'+new_pot_filename,
+            '--ignore-dirs="app/localization/utils app/Resources"']
+
+    os.chdir('..')             # The command must be run in the parent directory.
+    babel_frontend.run(argv)   # Run the command
+    os.chdir('localization')   # Return to the original directory.
+    if verbose:
+        print('Done.')
+
+def find_new_entries(verbose=False):
+    """
+    Count new entries in the new POT file.
+    
+    Returns:
+        int: number of new entries.
+        int: number of entries in the new POT file.
+    """
+    if verbose:
+        print('Making a list of message IDs in the new template... ', end='')
+
+    new_pot_msgids = []
+    current_pot_msgids = []
+    untranslated_new = 0
+
+    if not os.path.exists(current_pot_filename):
+        # if current pot file doesn't exist, copy it from new pot file.
+        if verbose:
+            print('INFO: create {}... '.format(current_pot_filename), end='')
+        shutil.copy(new_pot_filename, current_pot_filename)
+
+        # all entries are new.
+        po_new = polib.pofile(new_pot_filename)
+        untranslated_new = len(po_new.untranslated_entries())
+
+    else:
+        po_new = polib.pofile(new_pot_filename)
+        for entry in po_new:
+            if entry.msgid != '':
+                new_pot_msgids.append(entry.msgid)
+    
+        po = polib.pofile(current_pot_filename)
+        for entry in po:
+            if entry.msgid != '':
+                current_pot_msgids.append(entry.msgid)
+    
+        for id in new_pot_msgids:
+            if id not in current_pot_msgids:
+                untranslated_new += 1
+
+    if verbose:
+        print('{} new entries are found. Done.'.format(untranslated_new))
+    return untranslated_new, len(po_new.untranslated_entries())
+
+def merge_new_entries(verbose=False):
+    """
+    Merge new POT file to PO files.
+    The 'Project-Id-Version' and 'POT-Creation-Date' in the PO files will be updated.
+    No other metadata will be changed.
+
+    returns:
+        None
+    """
+    if verbose:
+        print('Merging new POT to PO files...')
+
+    pot = polib.pofile(new_pot_filename) # pot: for updating existing PO file
+    pot_new = polib.pofile(new_pot_filename, wrapwidth=79) # pot_new: for creating new PO file
+    pot_new.metadata.update(poedit_mime_headers) # update header of new PO file
+    
+    for loc in os.listdir(locale_dir):
+        lc_message_dir = os.path.join(locale_dir, loc,'LC_MESSAGE')
+        messages_po_path = os.path.join(lc_message_dir, 'messages.po')
+        if not os.path.exists(lc_message_dir) or not os.path.isdir(lc_message_dir):
+            print('WARNING: {} is not a valid locale directory.'.format(loc))
+            continue
+        if os.path.exists(os.path.join(locale_dir, loc, 'LC_MESSAGE','messages.po')):
+            if verbose:
+                print('  merge new POT to {}...'.format(messages_po_path))
+            po = polib.pofile(messages_po_path, wrapwidth=79)
+            po.merge(pot) #merge 
+            # update Project-Id-Version and POT-Creation-Date           
+            po.metadata['Project-Id-Version'] = pot.metadata['Project-Id-Version']
+            po.metadata['POT-Creation-Date'] = pot.metadata['POT-Creation-Date']
+            po.save() # overwrite
+        else:
+            # creating new PO file: need to modify "Language" metadata
+            pot_new.metadata['Language'] = loc[:loc.find('_')]
+            pot_new.save(messages_po_path)
+
+    if verbose:
+        print('Done.')
+
+def check_translation_status(verbose=False):
+    """
+    Count translated messages in the PO files.
+
+    returns:
+        dict: number of translated messages (key: locale code)
+    """
+    status = {}
+
+    if verbose:
+        print('Checking current PO files...', end='')
+    for loc in os.listdir(locale_dir):
+        lc_message_dir = os.path.join(locale_dir, loc,'LC_MESSAGE')
+        messages_po_path = os.path.join(lc_message_dir, 'messages.po')
+        if os.path.exists(os.path.join(locale_dir, loc, 'LC_MESSAGE','messages.po')):
+            po = polib.pofile(messages_po_path)
+            translated = len(po.translated_entries())
+            status[loc] = translated
+    
+    if verbose:
+        print('Done.')
+    return status
 
-print('Maing a list of message IDs in the new template... ', end='')
 
-new_pot_message_ids = []
-current_pot_id = []
-untranslated_new = []
-
-with codecs.open(new_pot_filename, 'r', 'utf-8') as fp:
-    for message in babel.messages.pofile.read_po(fp):
-        if message.id:
-            new_pot_message_ids.append(message.id)
+parser = argparse.ArgumentParser(description='usage: generateTranslationTemplate.py [-h] [-c]')
+parser.add_argument('-c', '--commit', action='store_true', help='Commit messages.pot if updated.', required=False)
+parser.add_argument('-v', '--verbose', action='store_true', help='Show detailed processing information.', required=False)
 
-if not os.path.exists(current_pot_filename):
-    # if current pot file doesn't exist, copy it from new pot file.
-    shutil.copy(new_pot_filename, current_pot_filename)
+args = parser.parse_args()
 
-with codecs.open(current_pot_filename, 'r', 'utf-8') as fp:
-    for message in babel.messages.pofile.read_po(fp):
-        if message.id:
-            current_pot_id.append(message.id)
+parent_dir, current_dir = os.path.split(os.getcwd())
+if current_dir != 'localization' or os.path.split(parent_dir)[1] != 'psychopy':
+    print('Error: this script must be run in psychopy/localization directory.')
+    sys.exit(-1)
 
-for id in new_pot_message_ids:
-    if id not in current_pot_id:
-        untranslated_new.append(id)
+generate_new_template(verbose=args.verbose)
+num_new_entries, num_total_entries = find_new_entries(verbose=args.verbose)
 
+# if there are new entries, merge POT to existing PO files.
+if num_new_entries > 0:
+    merge_new_entries(verbose=args.verbose)
 
-print('Done.')
+# check translation status
+translation_status = check_translation_status(verbose=args.verbose)
 
-#
-# Output summary
-#
 
-print('Checking current PO files...')
-
-n_untranslated_locale = []
-
-for root, dirs, files in os.walk('../app/locale/'):
-    for file in files:
-        if file=='messages.po':
-            po_message_ids = []
-            n_untranslated = 0
-            locale_identifier = os.path.basename(os.path.dirname(root))
-            print('{}: '.format(locale_identifier), end='')
-            try:
-                with codecs.open(os.path.join(root, file), 'r', 'utf-8') as fp:
-                    catalog = babel.messages.pofile.read_po(fp)
-                    for message in catalog:
-                        if message.id:
-                            po_message_ids.append(message.id)
-                            # found in the new POT, but not translated
-                            if message.id in new_pot_message_ids and message.string == '':
-                                n_untranslated += 1
-                for id in new_pot_message_ids:
-                    # not found in the current PO (it must be untranslated)
-                    if id not in po_message_ids:
-                        n_untranslated += 1
-                n_untranslated_locale.append((locale_identifier, n_untranslated))
-            except ValueError:
-                # If date strings in PO file is wrong (e.g. empty string),
-                # read_po() raises ValueError.
-                print('Skip.')
-            else:
-                print('Ok.')
-
-n_messages = len(new_pot_message_ids)
-summary_message = '\nNumber of messages in *.py files: {}\n'.format(n_messages)
-summary_message += 'New message(s): {}\n\n'.format(len(untranslated_new))
+summary_message = '\nNumber of messages in *.py files: {}\n'.format(num_total_entries)
+summary_message += 'New message(s): {}\n\n'.format(num_new_entries)
 summary_message += 'Untranslated message(s)\n'
 
-for locale_identifier, n in n_untranslated_locale:
-    summary_message += '  {}:{:>8} ({:>5.1f}%)\n'.format(locale_identifier, n, 100*n/n_messages)
+for loc in translation_status.keys():
+    n = translation_status[loc]
+    summary_message += '  {}:{:>8} ({:>5.1f}%)\n'.format(loc, n, 100*n/num_total_entries)
 
 # output to stdout
-sys.stdout.write(summary_message)
+print(summary_message)
 
-
-#
 # Update current pot file only if new strings were found.
-#
-
 
-if len(untranslated_new) > 0:
+if num_new_entries > 0:
     # replace current pot file with new one.
     os.remove(current_pot_filename)
     os.rename(new_pot_filename, current_pot_filename)
 
     # add and commit template file if --commit is given
-    if command_args.commit:
-        sys.stdout.write('\nCommit messages.pot...\n')
+    if args.commit:
+        if args.verbose:
+            sys.stdout.write('\nCommit messages.pot...\n')
+
         repo = git.Repo('../../')
-        
-        
-        pot_file_path = 'psychopy/localization/' + current_pot_filename
-        print(pot_file_path)
-        print([item.a_path for item in repo.index.diff(None)])
-        if pot_file_path in repo.untracked_files or pot_file_path in [item.a_path for item in repo.index.diff(None)]:
-            repo.index.add([pot_file_path])
-            repo.index.commit('ENH: Translation template is updated')
+        updated = [item.a_path for item in repo.index.diff(None)]
+        added = False
+
+        # add if messages.pot is untracked or updated
+        for file_path in target_files:
+            if file_path in repo.untracked_files or file_path in updated:
+                if args.verbose:
+                    print('  add {}'.format(file_path))
+                repo.index.add(file_path)
+                added = True
+
+        for loc in os.listdir(locale_dir):
+            file_path = '/'.join(('psychopy/app/locale', loc,'LC_MESSAGE', 'messages.po'))
+            if file_path in repo.untracked_files or file_path in updated:
+                if args.verbose:
+                    print('  add {}'.format(file_path))
+                repo.index.add(file_path)
+                added = True
+
+        if added:
+            repo.index.commit('ENH: Translation template is updated\n\n{}'.format(summary_message))
 
 else:
     # keep current pot file and remove new one.