Support `ListOption`s with have a list as default value

[Martin Scharrer]

The ListOption can work with a comma or otherwise separated string or a list (or similar) as default argument. The underlying getlist is checking the type and handles both cases. Unfortunately the IniAdminPlugin does not handles lists as default value and passes them to Genshi template where they are displayed without the separator.

For example the ctxtnav_names option of the AnnouncerPlugin has a default value of [_('Watch This'),_('Unwatch This')] which is shown as Watch ThisUnwatch This in the panel.

I like to suggest the following changes which resemble the way getlist handles this case:

iniadminplugin/0.11/iniadmin/iniadmin.py

@@ -75 +75 @@
             value = self.env.config.get(page, option.name)
             # We assume the classes all end in "Option"
             type = option.__class__.__name__.lower()[:-6] or 'text'
+            # Handle list option which have a list as default value
+            if type == 'list' and not isinstance(value,basestring):
+                value = unicode(option.sep).join(list(value))
             option_data  = {'name': option.name, 'default': option.default,
                            'doc': Markup(doc), 'value': value, 'type': type}
             if type == 'extension':

[Ryan J Ollos]

(In [8899]) Support ListOptions that have a list as a default value. Fixes #7686.

[Ryan J Ollos]

Thanks for the patch! I had meant to credit you in the log message, but it slipped my mind while doing the commit.

[Martin Scharrer]

No problem, thanks for applying the patch so quickly.

[Robert Corsaro]

01:43:36 PM Trac[main] ERROR: Internal Server Error: 
Traceback (most recent call last):
  File "/home/doki_pen/th-announcer/lib/python2.6/site-packages/trac/web/main.py", line 513, in _dispatch_request
    dispatcher.dispatch(req)
  File "/home/doki_pen/th-announcer/lib/python2.6/site-packages/trac/web/main.py", line 235, in dispatch
    resp = chosen_handler.process_request(req)
  File "/home/doki_pen/th-announcer/lib/python2.6/site-packages/trac/admin/web_ui.py", line 116, in process_request
    path_info)
  File "/home/doki_pen/th-announcer/lib/python2.6/site-packages/iniadmin/iniadmin.py", line 79, in render_admin_panel
    value = unicode(option.sep).join(list(value))

[Martin Scharrer]

The error messages from the log file would be really helpful here.

[Robert Corsaro]

I figured it out. It's because we had a ListOption defined with a default value of:

[_('Watch This'), _('Unwatch This')], which doesn't make much sense. babel LazyProxy objects where passed into the join, which doesn't work. The correct solution was to wrap the strings in _() before they are rendered, instead of in the ListOption definition.

[Martin Scharrer]

Replying to doki_pen:

I figured it out. It's because we had a ListOption defined with a default value of:

[_('Watch This'), _('Unwatch This')], which doesn't make much sense. babel LazyProxy objects where passed into the join, which doesn't work. The correct solution was to wrap the strings in _() before they are rendered, instead of in the ListOption definition.

Ok, makes sense. But you still need to mark them for the message extractor. I think the N_ function does this. AFAIK it returns the string unchanged but the message extractor will acknowledge it. As you mentioned later when the navigation items are rendered they must be processed with _ or directly gettext. I do this with the option doc texts in the dev branch of the WatchlistPlugin.