Merge lp:~max-rabkin/ibid/config-dflt-336627 into lp:~ibid-core/ibid/old-trunk-1.6

[Max Rabkin]

Display the default value when unset config options are queried

[Stefano Rivera (stefanor)]

find_option's docstring should be clearer that only plugins / sources are supported, and then only the Options themselves, not data within nested dicts.

. in a regex needs to be escaped

> for thing in things

Meh I hate that. I'd be tempted to use plugin and plugins. Sources are also plugins, in the general sense.

Query: get config plugins.core
Response: Keys: names and ignore
Query: get config plugins.core.limit_time
Response: 10

limit_time is query-able, but not listed.

Query: get config sources.atrum.delay_factor
Response: No such option

Something's not quite right

review: Needs Fixing

[lp:~max-rabkin/ibid/config-dflt-336627]

1018. By Max Rabkin on 2011-03-06

Clarify scope of find_option

1019. By Max Rabkin on 2011-03-06

Allow sub-options

1020. By Max Rabkin on 2011-05-28

Support partial option keys

[Max Rabkin (max-rabkin)]

> find_option's docstring should be clearer that only plugins / sources are supported,

Done in r1018

> and then only the Options themselves, not data within nested dicts.

Fixed in r1019

> limit_time is query-able, but not listed.

Fixed in r1020

> Query: get config sources.atrum.delay_factor
> Response: No such option

We can't find options in sources or plugins that aren't loaded.

[Stefano Rivera (stefanor)]

Line 40 looks like it's missing a \ before a . (although I don't think it'll make any practical difference)

Otherwise LGTM

[lp:~max-rabkin/ibid/config-dflt-336627]

1021. By Max Rabkin on 2011-06-19

Escape dot separator

1022. By Max Rabkin on 2011-06-19

Behave nicely for "get config plugins"

1023. By Max Rabkin on 2011-06-19

cleanup

[Stefano Rivera (stefanor)]

review: Approve

[Jonathan Hitchcock (vhata)]

review: Approve

Unmerged revisions

1023. By Max Rabkin on 2011-06-19

cleanup

1022. By Max Rabkin on 2011-06-19

Behave nicely for "get config plugins"

1021. By Max Rabkin on 2011-06-19

Escape dot separator

1020. By Max Rabkin on 2011-05-28

Support partial option keys

1019. By Max Rabkin on 2011-03-06

Allow sub-options

1018. By Max Rabkin on 2011-03-06

Clarify scope of find_option

1017. By Max Rabkin on 2011-03-06

Factor out find_option

1016. By Max Rabkin on 2011-03-06

Read defaults for config get

=== modified file 'ibid/plugins/admin.py'
--- ibid/plugins/admin.py	2010-04-13 10:06:03 +0000
+++ ibid/plugins/admin.py	2011-06-19 12:29:29 +0000
@@ -1,13 +1,15 @@
 # Copyright (c) 2008-2010, Michael Gorven
 # Released under terms of the MIT/X/Expat Licence. See COPYING for details.
 
+import logging
 from os.path import join
+import re
+
 from twisted.internet import reactor
-import logging
 
 import ibid
 from ibid.utils import human_join
-from ibid.config import FileConfig
+from ibid.config import FileConfig, Option
 from ibid.plugins import Processor, match, authorise, auth_responses
 from ibid.utils import ibid_version
 
@@ -19,18 +21,19 @@
     'description': u'Lists, loads and unloads plugins.',
     'categories': ('admin',),
 }
-class ListPLugins(Processor):
+class ListPlugins(Processor):
     usage = u'list plugins'
     features = ('plugins',)
 
     @match(r'lsmod|list plugins')
     def handler(self, event):
-        plugins = []
-        for processor in ibid.processors:
-            if processor.name not in plugins:
-                plugins.append(processor.name)
+        event.addresponse(u'Plugins: %s', human_join(sorted(list_plugins())) or u'none')
 
-        event.addresponse(u'Plugins: %s', human_join(sorted(plugins)) or u'none')
+def list_plugins():
+    plugins = set()
+    for processor in ibid.processors:
+        plugins.add(processor.name)
+    return sorted(plugins)
 
 features['core'] = {
     'description': u'Reloads core modules.',
@@ -211,17 +214,79 @@
 
         event.addresponse(True)
 
+    def find_option(self, key):
+        """
+        Find the Option object(s) for a config key in a plugin or source.
+
+        Returns None if the key does not correspond to an Option object.
+
+        Returns a dictionary mapping option names to (option, object) pairs as
+        below, if key is of the form plugins.pluginname or sources.sourcename.
+
+        Otherwise, returns (option, object, key_tail) where option is an
+        Option instance, and object is either a Processor or Source object
+        through which the option is accessed, and key_tail is the part of
+        the key which names a sub-option of this option (or a blank string).
+        """
+        m = re.match(r'^(plugins|sources)\.([^.]+)(?:\.([^.]+)(?:\.(.+))?)?$', key)
+        if m is None:
+            return None
+
+        kind, plugin, name, key_tail = m.groups()
+        if kind == 'sources':
+            if plugin in ibid.sources:
+                things = [ibid.sources[plugin]]
+            else:
+                return None
+        else:
+            things = [p for p in ibid.processors if p.name == plugin]
+
+        if name is None:
+            mapping = {}
+        else:
+            mapping = None
+
+        for thing in things:
+            options = thing.__dict__.values() + \
+                        type(thing).__dict__.values()
+            for option in options:
+                if isinstance(option, Option):
+                    if name is None:
+                        mapping[option.name] = (option, thing)
+                    elif option.name == name:
+                        return option, thing, key_tail or u''
+        return mapping
+
     @match(r'(?:get config|config get) (\S+?)')
     def get(self, event, key):
         if 'password' in key.lower() and not auth_responses(event, u'config'):
             return
 
-        config = ibid.config
-        for part in key.split('.'):
-            if not isinstance(config, dict) or part not in config:
-                event.addresponse(u'No such option')
-                return
-            config = config[part]
+        option = self.find_option(key)
+        if isinstance(option, dict):
+            config = option
+            key = ''
+        elif option is not None:
+            config = option[0].__get__(option[1], type(option[1]))
+            key = option[2]
+        elif key == 'plugins':
+            # Construct a dictionary since this isn't a list-valued option,
+            # but a list of option keys.
+            config = dict((plugin, None) for plugin in list_plugins())
+            key = ''
+        elif key == 'sources':
+            config = ibid.sources
+            key = ''
+        else:
+            config = ibid.config
+
+        if key:
+            for part in key.split('.'):
+                if not isinstance(config, dict) or part not in config:
+                    event.addresponse(u'No such option')
+                    return
+                config = config[part]
+
         if isinstance(config, list):
             event.addresponse(u', '.join(config))
         elif isinstance(config, dict):