Added localization framework to mssql-cli (dbcli#272)

.gitignore

@@ -54,7 +54,6 @@ junit/
 .DS_Store
 
 # Translations
-*.mo
 *.pot
 
 # Django stuff:

build.py

@@ -6,6 +6,8 @@
 import uuid
 import platform
 import utility
+import polib
+
 
 # Environment variables below allow the build process to use a python interpreter and pip version different
 # from the user's PATH. When building our linux packages on various distros, we want to be build machine agnostic, so we
@@ -169,6 +171,44 @@ def validate_actions(user_actions, valid_targets):
             sys.exit(1)
 
 
+def generate_mo(extraction_target_path, lang_name, trans_mappings, domain, localedir=None):
+    """
+    Extracts strings from 'extraction_target_path', and creates pot, po, mo file with 'trans_mappings' information.\
+    'extraction_target_path' can be file or directory.
+    """
+    extraction_target_dir = extraction_target_path\
+        if os.path.isdir(extraction_target_path) else os.path.dirname(extraction_target_path)
+    localedir = localedir if (not localedir is None) else os.path.join(extraction_target_dir, 'locale')
+    mo_dir = os.path.join(localedir, lang_name, 'LC_MESSAGES')
+    create_dir([extraction_target_dir, 'locale', lang_name, 'LC_MESSAGES'])
+
+    pot_file = '{0}.pot'.format(os.path.join(localedir, domain))
+    po_file = '{0}.po'.format(os.path.join(mo_dir, domain))
+    mo_file = '{0}.mo'.format(os.path.join(mo_dir, domain))
+
+    extract_command = "pybabel extract {0} -o {1}".format(extraction_target_path, pot_file)
+    utility.exec_command(extract_command, extraction_target_dir)
+
+    po = polib.pofile(pot_file)
+    for entry in po:
+        if (entry.msgid in trans_mappings):
+            entry.msgstr = trans_mappings[entry.msgid]
+    po.save(po_file)
+    po.save_as_mofile(mo_file)
+    return domain, localedir
+
+
+def create_dir(path):
+    curr_path = None
+    for p in path:
+        if (curr_path is None):
+            curr_path = os.path.abspath(p)
+        else:
+            curr_path = os.path.join(curr_path, p)
+        if (not os.path.exists(curr_path)):
+            os.mkdir(curr_path)
+
+
 if __name__ == '__main__':
     default_actions = ['build', 'unit_test']
 

mssqlcli/localized_strings.py

@@ -0,0 +1,19 @@
+import gettext
+import os
+from importlib import import_module
+
+PATH = '{0}.py'.format(os.path.splitext(__file__)[0])
+DOMAIN = 'mssql-cli'
+LOCALE_DIR = os.path.join(os.path.dirname(__file__), 'locale')
+LANGUAGES = None
+
+def translation(domain=DOMAIN, localedir=LOCALE_DIR, languages=None):
+    languages = languages if (not languages is None) else LANGUAGES
+    return gettext.translation(domain, localedir, languages, fallback=True)
+
+translation().install()
+
+
+## Localized Strings
+def goodbye():
+    return _(u'Goodbye!')

mssqlcli/mssql_cli.py

@@ -16,7 +16,6 @@
 from collections import namedtuple
 from time import time
 
-
 from mssqlcli.config import (
     get_casing_file,
     config_location,
@@ -40,17 +39,16 @@
 from prompt_toolkit.shortcuts.prompt import PromptSession, CompleteStyle
 from prompt_toolkit.completion import DynamicCompleter, ThreadedCompleter
 from prompt_toolkit.enums import DEFAULT_BUFFER, EditingMode
-
 from prompt_toolkit.document import Document
 from prompt_toolkit.filters import HasFocus, IsDone
-
 from prompt_toolkit.lexers import PygmentsLexer
 from prompt_toolkit.layout.processors import (ConditionalProcessor,
                                               HighlightMatchingBracketProcessor,
                                               TabsProcessor)
 from prompt_toolkit.history import FileHistory
 from prompt_toolkit.auto_suggest import AutoSuggestFromHistory
 from pygments.lexers.sql import PostgresLexer
+import mssqlcli.localized_strings as localized
 
 
 # Query tuples are used for maintaining history
@@ -411,7 +409,8 @@ def run(self):
         except EOFError:
             self.mssqlcliclient_main.shutdown()
             if not self.less_chatty:
-                print('Goodbye!')
+                print(localized.goodbye())
+
 
     def _build_cli(self, history):
 

mssqlcli/mssqlclioptionsparser.py

@@ -120,8 +120,7 @@ def create_parser():
         dest=u'multi_subnet_failover',
         action=u'store_true',
         default=False,
-        help=u'If application is connecting to AlwaysOn AG on different subnets, setting this provides faster '
-             u'detection and connection to currently active server.')
+        help=u'If application is connecting to AlwaysOn AG on different subnets, setting this provides faster detection and connection to currently active server.')
 
     args_parser.add_argument(
         u'-a', u'--packet-size',

requirements-dev.txt

@@ -25,3 +25,5 @@ configobj >= 5.0.6
 humanize >= 0.5.1
 cli_helpers >= 0.2.3, < 1.0.0
 mock>=1.0.1
+babel>=2.7.0
+polib>=1.1.0

tests/test_localization.py

@@ -0,0 +1,18 @@
+# -*- coding: utf-8 -*-
+import unittest
+import sys
+import mssqlcli.localized_strings as localized
+
+
+class LocalizationTests(unittest.TestCase):
+
+    def test_product(self):
+        original = self.unicode(localized.goodbye())
+        localized.translation(languages=['ko']).install()
+        translated = self.unicode(localized.goodbye())
+        assert original != translated
+
+    def unicode(self, s):
+        if (sys.version_info.major < 3 and isinstance(s, str)):
+            return s.decode('utf-8')
+        return s