Changeset 12721

Timestamp:

Mar 14, 2013, 8:55:12 PM (11 years ago)

Author:

Steffen Hoffmann

Message:

AccountManagerPlugin: Change class doc-string extraction for i18n to actually work.

This especially reverts and reworks parts of [12589] and [12663].
The exploration after cboos's hint in ​t:#11088 made me turn round and use an
approach closely resembling what already had been done to translate docs for
Trac core WikiMacros, although I changed it to fit for Trac 0.12 as well.

Trac core functions are used by default, but the configuration is tweaked
intentionally to not create catalogs in the '*-js' and 'tracini' domain.
So everything is still collected in 'messages', even if three compiler runs
on the same set of catalogs and generating unneeded message javascripts look
a bit awkward.

Because compatibility code predominated in acct_mgr.util it was about time
to re-arrange and form a dedicated acct_mgr.compat module.

Location:

accountmanagerplugin/trunk

Files:

• acct_mgr/admin.py (modified) (4 diffs)
• acct_mgr/api.py (modified) (1 diff)
• acct_mgr/compat.py (added)
• acct_mgr/htdocs/js (added)
• acct_mgr/htdocs/js/acctmgr_admin.js (moved) (moved from accountmanagerplugin/trunk/acct_mgr/htdocs/acctmgr_admin.js)
• acct_mgr/macros.py (modified) (1 diff)
• acct_mgr/model.py (modified) (1 diff)
• acct_mgr/register.py (modified) (7 diffs)
• acct_mgr/tests/admin.py (modified) (1 diff)
• acct_mgr/util.py (modified) (3 diffs)
• acct_mgr/web_ui.py (modified) (1 diff)
• setup.cfg (modified) (2 diffs)
• setup.py (modified) (2 diffs)

accountmanagerplugin/trunk/acct_mgr/admin.py

@@ -30 +30 @@
 from acct_mgr.api import IUserIdChanger
 from acct_mgr.api import _, N_, dgettext, gettext, ngettext, tag_
+from acct_mgr.compat import as_int, is_enabled, exception_to_unicode
+from acct_mgr.compat import get_pretty_dateinfo
 from acct_mgr.guard import AccountGuard
 from acct_mgr.model import change_uid, del_user_attribute, email_verified
@@ -36 +38 @@
 from acct_mgr.register import RegistrationModule
 from acct_mgr.web_ui import AccountModule, LoginModule
-from acct_mgr.util import as_int, is_enabled, exception_to_unicode
-from acct_mgr.util import get_pretty_dateinfo, pretty_precise_timedelta
+from acct_mgr.util import pretty_precise_timedelta
 
 
@@ -696 +697 @@
             # acct_mgr.register.GenericRegistrationInspector.
             try:
-                doc = gettext(check.doc)
+                if check._description:
+                    doc = gettext(check._description)
             except AttributeError:
                 doc = check.__class__.__doc__
@@ -819 +821 @@
         data.update(dict(roundup=roundup, roundup_defaults=roundup_defaults))
 
-        add_script(req, 'acct_mgr/acctmgr_admin.js')
+        add_script(req, 'acct_mgr/js/acctmgr_admin.js')
         add_stylesheet(req, 'acct_mgr/acctmgr.css')
         add_stylesheet(req, 'common/css/report.css')

accountmanagerplugin/trunk/acct_mgr/api.py

@@ -48 +48 @@
                 pass
         return string
+
+from acct_mgr.compat import cleandoc
+cleandoc_ = cleandoc
 
 

accountmanagerplugin/trunk/acct_mgr/macros.py

@@ -20 +20 @@
 from acct_mgr.admin import fetch_user_data
 from acct_mgr.api import AccountManager, CommonTemplateProvider, _
+from acct_mgr.compat import get_pretty_dateinfo
 from acct_mgr.guard import AccountGuard
-from acct_mgr.util import get_pretty_dateinfo
 
 

accountmanagerplugin/trunk/acct_mgr/model.py

@@ -16 +16 @@
 
 from acct_mgr.api import GenericUserIdChanger
+from acct_mgr.compat import as_int, exception_to_unicode
 from acct_mgr.hashlib_compat import md5
-from acct_mgr.util import as_int, exception_to_unicode
 
 

accountmanagerplugin/trunk/acct_mgr/register.py

@@ -27 +27 @@
 from acct_mgr.api import AccountManager, CommonTemplateProvider
 from acct_mgr.api import IAccountRegistrationInspector
-from acct_mgr.api import _, N_, dgettext, gettext, tag_
+from acct_mgr.api import _, N_, cleandoc_, dgettext, gettext, tag_
+from acct_mgr.compat import is_enabled
 from acct_mgr.model import email_associated, get_user_attribute
 from acct_mgr.model import set_user_attribute
-from acct_mgr.util import containsAny, is_enabled
+from acct_mgr.util import containsAny
 
 
@@ -52 +53 @@
 class GenericRegistrationInspector(Component):
     """Generic check class, great for creating simple checks quickly."""
+    _description = ''
 
     implements(IAccountRegistrationInspector)
 
     abstract = True
-
-    @property
-    def doc(self):
-        return N_(self.__class__.__doc__)
 
     def render_registration_fields(self, req, data):
@@ -85 +83 @@
 
 class BasicCheck(GenericRegistrationInspector):
+    _description = cleandoc_(
     """A collection of basic checks.
 
-This includes checking for
- * emptiness (no user input for username and/or password)
- * some blacklisted username characters
- * upper-cased usernames (reserved for Trac permission actions)
- * some reserved usernames
- * a username duplicate in configured password stores
-
-''This check is bypassed for requests regarding user's own preferences.''
-"""
+    This includes checking for
+     * emptiness (no user input for username and/or password)
+     * some blacklisted username characters
+     * upper-cased usernames (reserved for Trac permission actions)
+     * some reserved usernames
+     * a username duplicate in configured password stores
+
+    ''This check is bypassed for requests regarding user's own preferences.''
+    """)
 
     def validate_registration(self, req):
@@ -162 +161 @@
 
 class BotTrapCheck(GenericRegistrationInspector):
+    _description = cleandoc_(
     """A collection of simple bot checks.
 
-''This check is bypassed for requests by an authenticated user.''
-"""
+    ''This check is bypassed for requests by an authenticated user.''
+    """)
 
     reg_basic_token = Option('account-manager', 'register_basic_token', '',
@@ -212 +212 @@
 
 class EmailCheck(GenericRegistrationInspector):
+    _description = cleandoc_(
     """A collection of checks for email addresses.
 
-''This check is bypassed, if account verification is disabled.''
-"""
+    ''This check is bypassed, if account verification is disabled.''
+    """)
 
     def render_registration_fields(self, req, data):
@@ -273 +274 @@
 
 class RegExpCheck(GenericRegistrationInspector):
+    _description = cleandoc_(
     """A collection of checks based on regular expressions.
 
-''It depends on !EmailCheck being enabled too for using it's input field.
-Likewise email checking is bypassed, if account verification is disabled.''
-"""
+    ''It depends on !EmailCheck being enabled too for using it's input field.
+    Likewise email checking is bypassed, if account verification is disabled.''
+    """)
 
     username_regexp = Option('account-manager', 'username_regexp',
@@ -312 +314 @@
 
 class UsernamePermCheck(GenericRegistrationInspector):
+    _description = cleandoc_(
     """Check for usernames referenced in the permission system.
 
-''This check is bypassed for requests by an authenticated user.''
-"""
+    ''This check is bypassed for requests by an authenticated user.''
+    """)
 
     def validate_registration(self, req):

accountmanagerplugin/trunk/acct_mgr/tests/admin.py

@@ -39 +39 @@
 
 class DummyCheck(GenericRegistrationInspector):
-    @property
-    def doc(self):
-        return "A dummy check for unit-testing the interface."
+    _description = \
+    """A dummy check for unit-testing the interface."""
 
     def validate_registration(self, req):

accountmanagerplugin/trunk/acct_mgr/util.py

@@ -14 +14 @@
 import sys
 
-from genshi.builder import tag
-
 from trac.config import Option
 from trac.util.datefmt import format_datetime, pretty_timedelta
 from trac.util.datefmt import to_datetime, utc
-from trac.util.text import to_unicode
-from trac.web.chrome import Chrome
 
 from acct_mgr.api import _, ngettext
+
+
+class EnvRelativePathOption(Option):
+
+    def __get__(self, instance, owner):
+        if instance is None:
+            return self
+        path = super(EnvRelativePathOption, self).__get__(instance, owner)
+        if not path:
+            return path
+        return os.path.normpath(os.path.join(instance.env.path, path))
 
 
@@ -60 +67 @@
 
 
-class EnvRelativePathOption(Option):
-
-    def __get__(self, instance, owner):
-        if instance is None:
-            return self
-        path = super(EnvRelativePathOption, self).__get__(instance, owner)
-        if not path:
-            return path
-        return os.path.normpath(os.path.join(instance.env.path, path))
-
-
-try:
-    from trac.util import as_int
-# Provide the function for compatibility (available since Trac 0.12).
-except ImportError:
-    def as_int(s, default, min=None, max=None):
-        """Convert s to an int and limit it to the given range, or
-        return default if unsuccessful (copied verbatim from Trac0.12dev).
-        """
-        try:
-            value = int(s)
-        except (TypeError, ValueError):
-            return default
-        if min is not None and value < min:
-            value = min
-        if max is not None and value > max:
-            value = max
-        return value
-
 # taken from a comment of Horst Hansen
 # at http://code.activestate.com/recipes/65441
@@ -103 +81 @@
         return func(self, *args, **kwds)
     return wrap
-
-try:
-    from trac.util.text import exception_to_unicode
-# Provide the function for compatibility (available since Trac 0.11.3).
-except:
-    def exception_to_unicode(e, traceback=False):
-        """Convert an `Exception` to an `unicode` object.
-
-        In addition to `to_unicode`, this representation of the exception
-        also contains the class name and optionally the traceback.
-        This replicates the Trac core function for backwards-compatibility.
-        """
-        message = '%s: %s' % (e.__class__.__name__, to_unicode(e))
-        if traceback:
-            from trac.util import get_last_traceback
-            traceback_only = get_last_traceback().split('\n')[:-2]
-            message = '\n%s\n%s' % (to_unicode('\n'.join(traceback_only)),
-                                    message)
-        return message
-
-# Compatibility code for `pretty_dateinfo` from template data dict
-# (available since Trac 1.0)
-def get_pretty_dateinfo(env, req):
-    """Return the function defined in trac.web.chrome.Chrome.populate_data .
-
-    For Trac 0.11 and 0.12 it still provides a slightly simplified version.
-    """
-    # Function is not a class attribute, must be extracted from data dict.
-    fn = Chrome(env).populate_data(req, {}).get('pretty_dateinfo')
-    if not fn:
-        def _pretty_dateinfo(date, format=None, dateonly=False):
-            absolute = format_datetime(date, tzinfo=req.tz)
-            relative = pretty_timedelta(date)
-            if format == 'absolute':
-                label = absolute
-                # TRANSLATOR: Sync with same msgid in Trac 0.13, please.
-                title = _("%(relativetime)s ago", relativetime=relative)
-            else:
-                if dateonly:
-                    label = relative
-                else:
-                    label = _("%(relativetime)s ago", relativetime=relative)
-                title = absolute
-            return tag.span(label, title=title)
-    return fn and fn or _pretty_dateinfo
-
-# Compatibility code for `ComponentManager.is_enabled`
-# (available since Trac 0.12)
-def is_enabled(env, cls):
-    """Return whether the given component class is enabled.
-
-    For Trac 0.11 the missing algorithm is included as fallback.
-    """
-    try:
-        return env.is_enabled(cls)
-    except AttributeError:
-        if cls not in env.enabled:
-            env.enabled[cls] = env.is_component_enabled(cls)
-        return env.enabled[cls]
 
 def pretty_precise_timedelta(time1, time2=None, resolution=None, diff=0):

accountmanagerplugin/trunk/acct_mgr/web_ui.py

@@ -33 +33 @@
 from acct_mgr.api import AccountManager, CommonTemplateProvider
 from acct_mgr.api import _, dgettext, ngettext, tag_
+from acct_mgr.compat import is_enabled
 from acct_mgr.db import SessionStore
 from acct_mgr.guard import AccountGuard
 from acct_mgr.model import set_user_attribute, user_known
 from acct_mgr.register import EmailVerificationModule, RegistrationModule
-from acct_mgr.util import if_enabled, is_enabled
+from acct_mgr.util import if_enabled
 
 

accountmanagerplugin/trunk/setup.cfg

@@ -7 +7 @@
 msgid_bugs_address = hoff.st@shaas.net
 output_file = acct_mgr/locale/messages.pot
-keywords = _ ngettext:1,2 N_ tag_
+keywords = _ ngettext:1,2 N_ tag_  cleandoc_
 width = 72
 
@@ -23 +23 @@
 output_dir = acct_mgr/locale
 domain = acct_mgr
+
+[compile_catalog_js]
+directory = acct_mgr/locale
+domain = acct_mgr
+
+[generate_messages_js]
+domain = acct_mgr
+input_dir = acct_mgr/locale
+output_dir = acct_mgr/htdocs
+
+[compile_catalog_tracini]
+directory = acct_mgr/locale
+domain = acct_mgr

accountmanagerplugin/trunk/setup.py

@@ -10 +10 @@
 extra = {}
 
+has_trac_extract_python = False
 try:
-    from trac.util.dist  import  get_l10n_cmdclass
-    cmdclass = get_l10n_cmdclass()
+    from trac.util.dist import get_l10n_cmdclass
+    try:
+        from trac.dist import get_l10n_trac_cmdclass
+        cmdclass = get_l10n_trac_cmdclass()
+        has_trac_extract_python = True
+    except ImportError:
+        # Trac < 1.0, using other compatibility code here.
+        cmdclass = get_l10n_cmdclass()
     if cmdclass:
         extra['cmdclass'] = cmdclass
         extractors = [
-            ('**.py',                'python', None),
             ('**/templates/**.html', 'genshi', None),
         ]
+        if has_trac_extract_python:
+            extractors.append(
+                ('**.py', 'trac.dist:extract_python', None))
+        else:
+            extractors.append(
+                ('**.py', 'acct_mgr.compat:extract_python', None))
         extra['message_extractors'] = {
             'acct_mgr': extractors,
         }
-# i18n is implemented to be optional here
+# Trac < 0.12, i18n is implemented to be optional here.
 except ImportError:
     pass
@@ -42 +54 @@
     package_data={
         'acct_mgr': [
-            'htdocs/*', 'locale/*/LC_MESSAGES/*.mo', 'locale/.placeholder',
+            'htdocs/*.css', 'htdocs/js/*', 'htdocs/*.png',
+            'locale/*/LC_MESSAGES/*.mo', 'locale/.placeholder',
             'templates/*.html', 'templates/*.txt'
         ]