ticket 1705 - internationalize help topics

* Wrap each topic description in _()

* Replace the use of if 'topic' in dir(module) with the more
  Pythonic and efficient getattr(module, 'topic', None)

* Make sure to invoke unicode on the value returned from _()
  otherwise you'll get a GettextFactory instance, not a string

* Clean up trailing whitespace errors

7 files changed, 9 insertions, 11 deletions

diff --git a/ipalib/cli.py b/ipalib/cli.py
index 536fe2ecb..99416c90a 100644
--- a/ipalib/cli.py
+++ b/ipalib/cli.py
@@ -674,10 +674,8 @@ class help(frontend.Local):
             __import__(module_name)
         module = sys.modules[module_name]
 
-        dir_list = dir(module)
-        if 'topic' in dir_list:
-            topic = module.topic
-        else:
+        topic = getattr(module, 'topic', None)
+        if topic is None:
             topic = (self._get_command_module(module_name), None)
 
         return topic
@@ -728,7 +726,7 @@ class help(frontend.Local):
                         mcl = max((self._topics[topic_name][2][mod_name][1], len(c.name)))
                         self._topics[topic_name][2][mod_name][1] = mcl
                     else:
-                        self._topics[topic_name] = [topic[1], 0, {mod_name: [doc, 0, [c]]}]
+                        self._topics[topic_name] = [unicode(_(topic[1])), 0, {mod_name: [doc, 0, [c]]}]
                         self._count_topic_mcl(topic_name, mod_name)
             else:
                 self._builtins.append(c)
diff --git a/ipalib/plugins/hbacrule.py b/ipalib/plugins/hbacrule.py
index 0d8474fbd..1ea0259a2 100644
--- a/ipalib/plugins/hbacrule.py
+++ b/ipalib/plugins/hbacrule.py
@@ -85,7 +85,7 @@ from ipalib import AccessTime, Password, Str, StrEnum
 from ipalib.plugins.baseldap import *
 from ipalib import _, ngettext
 
-topic = ('hbac', 'Host-based access control commands')
+topic = ('hbac', _('Host-based access control commands'))
 
 def validate_type(ugettext, type):
     if type.lower() == 'deny':
diff --git a/ipalib/plugins/hbacsvc.py b/ipalib/plugins/hbacsvc.py
index c2041c3e6..a45d9d631 100644
--- a/ipalib/plugins/hbacsvc.py
+++ b/ipalib/plugins/hbacsvc.py
@@ -45,7 +45,7 @@ from ipalib.plugins.baseldap import LDAPUpdate, LDAPSearch, LDAPRetrieve
 
 from ipalib import _, ngettext
 
-topic = ('hbac', 'Host based access control commands')
+topic = ('hbac', _('Host based access control commands'))
 
 class hbacsvc(LDAPObject):
     """
diff --git a/ipalib/plugins/hbacsvcgroup.py b/ipalib/plugins/hbacsvcgroup.py
index 12db5f341..5154b18eb 100644
--- a/ipalib/plugins/hbacsvcgroup.py
+++ b/ipalib/plugins/hbacsvcgroup.py
@@ -45,7 +45,7 @@ from ipalib import api, errors
 from ipalib.plugins.baseldap import *
 from ipalib import _, ngettext
 
-topic = ('hbac', 'Host based access control commands')
+topic = ('hbac', _('Host based access control commands'))
 
 class hbacsvcgroup(LDAPObject):
     """
diff --git a/ipalib/plugins/sudocmd.py b/ipalib/plugins/sudocmd.py
index da78f0ec5..af8ab0321 100644
--- a/ipalib/plugins/sudocmd.py
+++ b/ipalib/plugins/sudocmd.py
@@ -40,7 +40,7 @@ from ipalib import Str
 from ipalib.plugins.baseldap import *
 from ipalib import _, ngettext
 
-topic = ('sudo', 'commands for controlling sudo configuration')
+topic = ('sudo', _('commands for controlling sudo configuration'))
 
 class sudocmd(LDAPObject):
     """
diff --git a/ipalib/plugins/sudocmdgroup.py b/ipalib/plugins/sudocmdgroup.py
index e613f4657..60d4b3878 100644
--- a/ipalib/plugins/sudocmdgroup.py
+++ b/ipalib/plugins/sudocmdgroup.py
@@ -44,7 +44,7 @@ from ipalib import Str
 from ipalib.plugins.baseldap import *
 from ipalib import _, ngettext
 
-topic = ('sudo', 'commands for controlling sudo configuration')
+topic = ('sudo', _('commands for controlling sudo configuration'))
 
 class sudocmdgroup(LDAPObject):
     """
diff --git a/ipalib/plugins/sudorule.py b/ipalib/plugins/sudorule.py
index 55affa653..c12620132 100644
--- a/ipalib/plugins/sudorule.py
+++ b/ipalib/plugins/sudorule.py
@@ -47,7 +47,7 @@ from ipalib import Str, StrEnum
 from ipalib.plugins.baseldap import *
 from ipalib import _, ngettext
 
-topic = ('sudo', 'Commands for controlling sudo configuration')
+topic = ('sudo', _('Commands for controlling sudo configuration'))
 
 def deprecated(attribute):
     raise errors.ValidationError(name=attribute, error=_('this option has been deprecated.'))