ENH: Support for scripted module internationalization

This commit adds CMake function "SlicerFunctionAddPythonScriptTrFilesTargets"
used to ensure input expected by lupdate/lrelease translation tools are
generated.

The CMake function associates custom commands with each python scripts
and also adds a convenience target called "Add<TargetName>PythonScriptTrFiles"
to explicitly regenerate the .py.tr files.

The custom commands generate the .py.tr files by invoking a python cli
(CMake/Rewrite.py) replacing calls to "slicer.util.tr" with "QT_TRANSLATE_NOOP".

The python cli "CMake/Rewrite.py" internally uses the astor python
package.

Updates SlicerConfig to set Slicer_BUILD_I18N_SUPPORT,
Slicer_UPDATE_TRANSLATION and Slicer_LANGUAGES.

Co-authored-by: Carlos Luque <carlos.luque@ulpgc.es>

Author: jcfr

Base/Python/CMakeLists.txt

@@ -6,6 +6,7 @@ set(Slicer_PYTHON_SCRIPTS
   slicer/slicerqt
   slicer/testing
   slicer/util
+  slicer/i18n
   freesurfer
   mrml
   vtkAddon

Base/Python/slicer/i18n.py

@@ -0,0 +1,4 @@
+
+def tr(context, text):
+  from slicer import app
+  return app.translate(context, text)

CMake/RewriteTr.py

@@ -0,0 +1,82 @@
+import ast
+import errno
+import getopt
+import os
+import sys
+
+import astor
+
+
+class RewriteTr(ast.NodeTransformer):
+    """Replace tr to QT_TRANSLATE_NOOP
+    """
+    def visit_Call(self, node):
+        self.generic_visit(node)
+        # Transform 'tr' into 'QT_TRANSLATE_NOOP' """
+        if (isinstance(node.func, ast.Name) and \
+           ("tr" == node.func.id) and \
+           len(node.args) == 2):
+            call = ast.Call(func=ast.Name(id='QT_TRANSLATE_NOOP', ctx=ast.Load()),
+                            args=node.args,
+                            keywords=[])
+            ast.copy_location(call, node)
+            # Add lineno & col_offset to the nodes we created
+            ast.fix_missing_locations(call)
+            return call
+         
+        # Return the original node if we don't want to change it.
+        return node
+
+
+def mkdir_p(path):
+    """Ensure directory ``path`` exists. If needed, parent directories
+    are created.
+    Adapted from http://stackoverflow.com/a/600612/1539918
+    """
+    try:
+        os.makedirs(path)
+    except OSError as exc:  # Python >2.5
+        if exc.errno == errno.EEXIST and os.path.isdir(path):
+            pass
+        else:  # pragma: no cover
+            raise
+
+
+def main(argv):
+
+    input_file = ''
+    output_file = ''
+    try:
+        opts, args = getopt.getopt(argv, "hi:o:", ["ifile=","ofile="])
+    except getopt.GetoptError:
+        print('RewriteTr.py -i <inputfile> -o <outputfile>')
+        sys.exit(2)
+    for opt, arg in opts:
+        if opt == '-h':
+            print('RewriteTr.py -i <inputfile> -o <outputfile>')
+            sys.exit()
+        elif opt in ("-i", "--ifile"):
+            input_file = arg
+        elif opt in ("-o", "--ofile"):
+            output_file = arg
+   
+    with open(input_file, "r") as source:
+        tree = ast.parse(source.read())
+
+    tree_new = RewriteTr().visit(tree)  
+    all_lines = astor.to_source(tree_new)
+    
+    # if needed, create output directory
+    output_dir = os.path.dirname(output_file)
+    #print("output_dir [%s]" % output_dir)
+    mkdir_p(output_dir)
+
+    # replace the single quotation marks to double quotation marks. It is necessary for lupdate
+    with open(output_file, "w") as destination:
+        for line in all_lines:
+            linenew = line.replace('\'', "\"")
+            destination.write(linenew)
+
+
+if __name__ == "__main__":
+    main(sys.argv[1:])

CMake/SlicerConfig.cmake.in

@@ -126,6 +126,12 @@ set(Slicer_BUILD_EXTENSIONMANAGER_SUPPORT "@Slicer_BUILD_EXTENSIONMANAGER_SUPPOR
 set(Slicer_BUILD_PARAMETERSERIALIZER_SUPPORT "@Slicer_BUILD_PARAMETERSERIALIZER_SUPPORT@")
 set(Slicer_BUILD_TESTING "@BUILD_TESTING@")
 set(Slicer_BUILD_WEBENGINE_SUPPORT "@Slicer_BUILD_WEBENGINE_SUPPORT@")
+set(Slicer_BUILD_I18N_SUPPORT "@Slicer_BUILD_I18N_SUPPORT@")
+set(Slicer_UPDATE_TRANSLATION "@Slicer_UPDATE_TRANSLATION@")
+
+if(Slicer_BUILD_I18N_SUPPORT)
+  set(Slicer_LANGUAGES  "@Slicer_LANGUAGES@")
+endif()
 
 set(Slicer_REQUIRED_QT_VERSION "@Slicer_REQUIRED_QT_VERSION@")
 set(Slicer_REQUIRED_QT_MODULES "@Slicer_REQUIRED_QT_MODULES@")
@@ -348,14 +354,15 @@ if(Slicer_USE_PYTHONQT)
   set(Slicer_INSTALL_QTSCRIPTEDMODULES_SHARE_DIR "@Slicer_INSTALL_QTSCRIPTEDMODULES_SHARE_DIR@")
 endif()
 
+set(Slicer_INSTALL_QM_DIR "@Slicer_INSTALL_QM_DIR@")
+
 set(Slicer_INSTALL_THIRDPARTY_BIN_DIR "${Slicer_INSTALL_ROOT}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_THIRDPARTY_BIN_DIR}")
 set(Slicer_INSTALL_THIRDPARTY_LIB_DIR "${Slicer_INSTALL_ROOT}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_THIRDPARTY_LIB_DIR}")
 set(Slicer_INSTALL_THIRDPARTY_SHARE_DIR "${Slicer_INSTALL_ROOT}${Slicer_BUNDLE_EXTENSIONS_LOCATION}${Slicer_THIRDPARTY_SHARE_DIR}")
 
 # The Slicer install prefix (*not* defined in the install tree)
 set(Slicer_INSTALL_PREFIX  "@CMAKE_INSTALL_PREFIX@")
 
-
 # --------------------------------------------------------------------------
 # Testing
 # --------------------------------------------------------------------------

CMake/SlicerMacroBuildScriptedModule.cmake

@@ -97,6 +97,9 @@ macro(slicerMacroBuildScriptedModule)
     set(_no_install_subdir_option "")
   endif()
 
+  # --------------------------------------------------------------------------
+  # Copy and/or compile scripts and associated resources
+  # --------------------------------------------------------------------------
   ctkMacroCompilePythonScript(
     TARGET_NAME ${MY_SLICER_NAME}
     SCRIPTS "${MY_SLICER_SCRIPTS}"
@@ -106,6 +109,16 @@ macro(slicerMacroBuildScriptedModule)
     ${_no_install_subdir_option}
     )
 
+  # --------------------------------------------------------------------------
+  # Translations
+  # --------------------------------------------------------------------------
+  if("${CTK_COMPILE_PYTHON_SCRIPTS_GLOBAL_TARGET_NAME}" STREQUAL "")
+    SlicerFunctionAddPythonScriptTrFilesTargets(${MY_SLICER_NAME})
+  endif()
+
+  # --------------------------------------------------------------------------
+  # Tests
+  # --------------------------------------------------------------------------
   if(BUILD_TESTING AND MY_SLICER_WITH_GENERIC_TESTS)
     set(_generic_unitest_scripts)
     SlicerMacroConfigureGenericPythonModuleTests("${MY_SLICER_NAME}" _generic_unitest_scripts)
@@ -122,3 +135,56 @@ macro(slicerMacroBuildScriptedModule)
 
 endmacro()
 
+function(SlicerFunctionAddPythonScriptTrFilesTargets target)
+
+  set(rewrite_script "${Slicer_CMAKE_DIR}/RewriteTr.py")
+  if(NOT EXISTS ${rewrite_script})
+    message(FATAL_ERROR "Rewrite script does not exist [${rewrite_script}]")
+  endif()
+
+  set(TS_DIR "${CMAKE_CURRENT_SOURCE_DIR}/Resources/Translations/")
+
+  #get_property(Slicer_LANGUAGES GLOBAL PROPERTY Slicer_LANGUAGES)
+
+  get_property(_CTK_${target}_PYTHON_SCRIPTS GLOBAL PROPERTY _CTK_${target}_PYTHON_SCRIPTS)
+
+  set(rewritten_srcs)
+  foreach(entry IN LISTS _CTK_${target}_PYTHON_SCRIPTS)
+    string(REPLACE "|" ";" tuple "${entry}")
+    list(GET tuple 0 src)
+    list(GET tuple 1 tgt_file)
+    list(GET tuple 2 dest_dir)
+
+    set(rewritten_src_file "${tgt_file}.tr")
+    set(rewritten_src "${dest_dir}/${rewritten_src_file}")
+
+    add_custom_command(DEPENDS ${src}
+                       COMMAND ${PYTHON_EXECUTABLE}
+                         ${rewrite_script} -i ${src} -o ${rewritten_src}
+                       OUTPUT ${rewritten_src}
+                       COMMENT "Generating .py.tr file into binary directory: ${rewritten_src_file}")
+
+    list(APPEND rewritten_srcs ${rewritten_src})
+  endforeach()
+
+  include(SlicerMacroTranslation)
+  SlicerMacroTranslation(
+    SRCS ${rewritten_srcs}
+    TS_DIR ${TS_DIR}
+    TS_BASEFILENAME ${target}
+    TS_LANGUAGES ${Slicer_LANGUAGES}
+    QM_OUTPUT_DIR_VAR QM_OUTPUT_DIR
+    QM_OUTPUT_FILES_VAR QM_OUTPUT_FILES
+    )
+
+  # store the paths where the qm files are located
+  set_property(GLOBAL APPEND PROPERTY Slicer_QM_OUTPUT_DIRS ${QM_OUTPUT_DIR})
+
+  # store the qm files associated with scripted modules
+  set_property(GLOBAL APPEND PROPERTY QM_SCRIPTED_MODULE_FILES ${QM_OUTPUT_FILES})
+
+  set(target_name Add${target}PythonScriptTrFiles)
+  if(NOT TARGET ${target_name})
+    add_custom_target(${target_name} DEPENDS ${rewritten_srcs} ${ARGN})
+  endif()
+endfunction()

CMakeLists.txt

@@ -417,7 +417,8 @@ include(SlicerFunctionAddPythonQtResources)
 #-----------------------------------------------------------------------------
 if(Slicer_BUILD_I18N_SUPPORT)
   set(Slicer_LANGUAGES
-    "fr"
+  "es_Es"
+  "fr_FR"
     )
   set_property(GLOBAL PROPERTY Slicer_LANGUAGES ${Slicer_LANGUAGES})
 endif()
@@ -1151,10 +1152,16 @@ ExternalData_Add_Target(${Slicer_ExternalData_DATA_MANAGEMENT_TARGET})
 #-----------------------------------------------------------------------------
 # Create targets CopySlicerPython{Resource, Script}Files, CompileSlicerPythonFiles
 if(Slicer_USE_PYTHONQT)
+
   slicerFunctionAddPythonQtResourcesTargets(SlicerPythonResources)
   ctkFunctionAddCompilePythonScriptTargets(
     ${CTK_COMPILE_PYTHON_SCRIPTS_GLOBAL_TARGET_NAME}
-    DEPENDS SlicerPythonResources
+    DEPENDS
+      SlicerPythonResources
+    )
+
+  SlicerFunctionAddPythonScriptTrFilesTargets(
+    ${CTK_COMPILE_PYTHON_SCRIPTS_GLOBAL_TARGET_NAME}
     )
 endif()
 

Modules/Scripted/Endoscopy/Endoscopy.py

@@ -5,6 +5,8 @@
 from slicer.ScriptedLoadableModule import *
 import logging
 
+from slicer.i18n import tr
+
 #
 # Endoscopy
 #
@@ -64,7 +66,7 @@ def setup(self):
 
     # Path collapsible button
     pathCollapsibleButton = ctk.ctkCollapsibleButton()
-    pathCollapsibleButton.text = "Path"
+    pathCollapsibleButton.text = tr("EndoscopyWidget", "Path")
     self.layout.addWidget(pathCollapsibleButton)
 
     # Layout within the path collapsible button
@@ -80,7 +82,7 @@ def setup(self):
     cameraNodeSelector.removeEnabled = False
     cameraNodeSelector.connect('currentNodeChanged(bool)', self.enableOrDisableCreateButton)
     cameraNodeSelector.connect('currentNodeChanged(vtkMRMLNode*)', self.setCameraNode)
-    pathFormLayout.addRow("Camera:", cameraNodeSelector)
+    pathFormLayout.addRow(tr("EndoscopyWidget", "Camera:"), cameraNodeSelector)
     self.parent.connect('mrmlSceneChanged(vtkMRMLScene*)',
                         cameraNodeSelector, 'setMRMLScene(vtkMRMLScene*)')
 
@@ -94,12 +96,12 @@ def setup(self):
     inputFiducialsNodeSelector.addEnabled = False
     inputFiducialsNodeSelector.removeEnabled = False
     inputFiducialsNodeSelector.connect('currentNodeChanged(bool)', self.enableOrDisableCreateButton)
-    pathFormLayout.addRow("Input Fiducials:", inputFiducialsNodeSelector)
+    pathFormLayout.addRow(tr("EndoscopyWidget", "Input Fiducials:"), inputFiducialsNodeSelector)
     self.parent.connect('mrmlSceneChanged(vtkMRMLScene*)',
                         inputFiducialsNodeSelector, 'setMRMLScene(vtkMRMLScene*)')
 
     # CreatePath button
-    createPathButton = qt.QPushButton("Create path")
+    createPathButton = qt.QPushButton(tr("EndoscopyWidget", "Create path"))
     createPathButton.toolTip = "Create the path."
     createPathButton.enabled = False
     pathFormLayout.addRow(createPathButton)
@@ -108,7 +110,7 @@ def setup(self):
 
     # Flythrough collapsible button
     flythroughCollapsibleButton = ctk.ctkCollapsibleButton()
-    flythroughCollapsibleButton.text = "Flythrough"
+    flythroughCollapsibleButton.text = tr("EndoscopyWidget", "Flythrough")
     flythroughCollapsibleButton.enabled = False
     self.layout.addWidget(flythroughCollapsibleButton)
 

SuperBuild.cmake

@@ -155,6 +155,10 @@ if(Slicer_USE_PYTHONQT)
   endif()
 endif()
 
+if(Slicer_BUILD_I18N_SUPPORT AND Slicer_USE_PYTHONQT)
+  list(APPEND Slicer_DEPENDENCIES python-astor)
+endif()
+
 if(Slicer_USE_TBB)
   list(APPEND Slicer_DEPENDENCIES tbb)
 endif()

SuperBuild/External_python-astor.cmake

@@ -0,0 +1,45 @@
+set(proj python-astor)
+
+# Set dependency list
+set(${proj}_DEPENDENCIES python python-setuptools)
+
+if(NOT DEFINED Slicer_USE_SYSTEM_${proj})
+  set(Slicer_USE_SYSTEM_${proj} ${Slicer_USE_SYSTEM_python})
+endif()
+
+# Include dependent projects if any
+ExternalProject_Include_Dependencies(${proj} PROJECT_VAR proj DEPENDS_VAR ${proj}_DEPENDENCIES)
+
+if(Slicer_USE_SYSTEM_${proj})
+  ExternalProject_FindPythonPackage(
+    MODULE_NAME "astor"
+    REQUIRED
+    )
+endif()
+
+if(NOT Slicer_USE_SYSTEM_${proj})
+
+  set(_version "0.7.1")
+
+  ExternalProject_Add(${proj}
+    ${${proj}_EP_ARGS}
+    URL "https://files.pythonhosted.org/packages/99/80/f9482277c919d28bebd85813c0a70117214149a96b08981b72b63240b84c/astor-${_version}.tar.gz"
+    URL_HASH "SHA256=95c30d87a6c2cf89aa628b87398466840f0ad8652f88eb173125a6df8533fb8d"
+    DOWNLOAD_DIR ${CMAKE_BINARY_DIR}
+    SOURCE_DIR ${CMAKE_BINARY_DIR}/${proj}
+    BUILD_IN_SOURCE 1
+    CONFIGURE_COMMAND ""
+    BUILD_COMMAND ""
+    INSTALL_COMMAND ${PYTHON_EXECUTABLE} setup.py install
+    LOG_INSTALL 1
+    DEPENDS
+      ${${proj}_DEPENDENCIES}
+    )
+
+  ExternalProject_GenerateProjectDescription_Step(${proj}
+    VERSION ${_version}
+    )
+
+else()
+  ExternalProject_Add_Empty(${proj} DEPENDS ${${proj}_DEPENDENCIES})
+endif()