disable string macros

IPython/config/loader.py

@@ -1,506 +1,502 b''
 """A simple configuration system.
 
 Authors
 -------
 * Brian Granger
 * Fernando Perez
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2008-2009  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 import __builtin__
 import re
 import sys
 
 from IPython.external import argparse
 from IPython.utils.path import filefind
 
 #-----------------------------------------------------------------------------
 # Exceptions
 #-----------------------------------------------------------------------------
 
 
 class ConfigError(Exception):
     pass
 
 
 class ConfigLoaderError(ConfigError):
     pass
 
 #-----------------------------------------------------------------------------
 # Argparse fix
 #-----------------------------------------------------------------------------
 
 # Unfortunately argparse by default prints help messages to stderr instead of
 # stdout.  This makes it annoying to capture long help screens at the command
 # line, since one must know how to pipe stderr, which many users don't know how
 # to do.  So we override the print_help method with one that defaults to
 # stdout and use our class instead.
 
 class ArgumentParser(argparse.ArgumentParser):
     """Simple argparse subclass that prints help to stdout by default."""
     
     def print_help(self, file=None):
         if file is None:
             file = sys.stdout
         return super(ArgumentParser, self).print_help(file)
     
     print_help.__doc__ = argparse.ArgumentParser.print_help.__doc__
     
 #-----------------------------------------------------------------------------
 # Config class for holding config information
 #-----------------------------------------------------------------------------
 
 
 class Config(dict):
     """An attribute based dict that can do smart merges."""
 
     def __init__(self, *args, **kwds):
         dict.__init__(self, *args, **kwds)
         # This sets self.__dict__ = self, but it has to be done this way
         # because we are also overriding __setattr__.
         dict.__setattr__(self, '__dict__', self)
 
     def _merge(self, other):
         to_update = {}
         for k, v in other.iteritems():
             if not self.has_key(k):
                 to_update[k] = v
             else: # I have this key
                 if isinstance(v, Config):
                     # Recursively merge common sub Configs
                     self[k]._merge(v)
                 else:
                     # Plain updates for non-Configs
                     to_update[k] = v
 
         self.update(to_update)
 
     def _is_section_key(self, key):
         if key[0].upper()==key[0] and not key.startswith('_'):
             return True
         else:
             return False
 
     def __contains__(self, key):
         if self._is_section_key(key):
             return True
         else:
             return super(Config, self).__contains__(key)
     # .has_key is deprecated for dictionaries.
     has_key = __contains__
 
     def _has_section(self, key):
         if self._is_section_key(key):
             if super(Config, self).__contains__(key):
                 return True
         return False
 
     def copy(self):
         return type(self)(dict.copy(self))
 
     def __copy__(self):
         return self.copy()
 
     def __deepcopy__(self, memo):
         import copy
         return type(self)(copy.deepcopy(self.items()))
 
     def __getitem__(self, key):
         # We cannot use directly self._is_section_key, because it triggers
         # infinite recursion on top of PyPy. Instead, we manually fish the
         # bound method.
         is_section_key = self.__class__._is_section_key.__get__(self)
         
         # Because we use this for an exec namespace, we need to delegate
         # the lookup of names in __builtin__ to itself.  This means
         # that you can't have section or attribute names that are 
         # builtins.
         try:
             return getattr(__builtin__, key)
         except AttributeError:
             pass
         if is_section_key(key):
             try:
                 return dict.__getitem__(self, key)
             except KeyError:
                 c = Config()
                 dict.__setitem__(self, key, c)
                 return c
         else:
             return dict.__getitem__(self, key)
 
     def __setitem__(self, key, value):
         # Don't allow names in __builtin__ to be modified.
         if hasattr(__builtin__, key):
             raise ConfigError('Config variable names cannot have the same name '
                               'as a Python builtin: %s' % key)
         if self._is_section_key(key):
             if not isinstance(value, Config):
                 raise ValueError('values whose keys begin with an uppercase '
                                  'char must be Config instances: %r, %r' % (key, value))
         else:
             dict.__setitem__(self, key, value)
 
     def __getattr__(self, key):
         try:
             return self.__getitem__(key)
         except KeyError, e:
             raise AttributeError(e)
 
     def __setattr__(self, key, value):
         try:
             self.__setitem__(key, value)
         except KeyError, e:
             raise AttributeError(e)
 
     def __delattr__(self, key):
         try:
             dict.__delitem__(self, key)
         except KeyError, e:
             raise AttributeError(e)
 
 
 #-----------------------------------------------------------------------------
 # Config loading classes
 #-----------------------------------------------------------------------------
 
 
 class ConfigLoader(object):
     """A object for loading configurations from just about anywhere.
     
     The resulting configuration is packaged as a :class:`Struct`.
     
     Notes
     -----
     A :class:`ConfigLoader` does one thing: load a config from a source 
     (file, command line arguments) and returns the data as a :class:`Struct`.
     There are lots of things that :class:`ConfigLoader` does not do.  It does
     not implement complex logic for finding config files.  It does not handle
     default values or merge multiple configs.  These things need to be 
     handled elsewhere.
     """
 
     def __init__(self):
         """A base class for config loaders.
         
         Examples
         --------
         
         >>> cl = ConfigLoader()
         >>> config = cl.load_config()
         >>> config
         {}
         """
         self.clear()
 
     def clear(self):
         self.config = Config()
 
     def load_config(self):
         """Load a config from somewhere, return a :class:`Config` instance.
         
         Usually, this will cause self.config to be set and then returned.
         However, in most cases, :meth:`ConfigLoader.clear` should be called
         to erase any previous state.
         """
         self.clear()
         return self.config
 
 
 class FileConfigLoader(ConfigLoader):
     """A base class for file based configurations.
 
     As we add more file based config loaders, the common logic should go
     here.
     """
     pass
 
 
 class PyFileConfigLoader(FileConfigLoader):
     """A config loader for pure python files.
     
     This calls execfile on a plain python file and looks for attributes
     that are all caps.  These attribute are added to the config Struct.
     """
 
     def __init__(self, filename, path=None):
         """Build a config loader for a filename and path.
 
         Parameters
         ----------
         filename : str
             The file name of the config file.
         path : str, list, tuple
             The path to search for the config file on, or a sequence of
             paths to try in order.
         """
         super(PyFileConfigLoader, self).__init__()
         self.filename = filename
         self.path = path
         self.full_filename = ''
         self.data = None
 
     def load_config(self):
         """Load the config from a file and return it as a Struct."""
         self.clear()
         self._find_file()
         self._read_file_as_dict()
         self._convert_to_config()
         return self.config
 
     def _find_file(self):
         """Try to find the file by searching the paths."""
         self.full_filename = filefind(self.filename, self.path)
 
     def _read_file_as_dict(self):
         """Load the config file into self.config, with recursive loading."""
         # This closure is made available in the namespace that is used
         # to exec the config file.  This allows users to call
         # load_subconfig('myconfig.py') to load config files recursively.
         # It needs to be a closure because it has references to self.path
         # and self.config.  The sub-config is loaded with the same path
         # as the parent, but it uses an empty config which is then merged
         # with the parents.
         def load_subconfig(fname):
             loader = PyFileConfigLoader(fname, self.path)
             try:
                 sub_config = loader.load_config()
             except IOError:
                 # Pass silently if the sub config is not there. This happens
                 # when a user us using a profile, but not the default config.
                 pass
             else:
                 self.config._merge(sub_config)
 
         # Again, this needs to be a closure and should be used in config
         # files to get the config being loaded.
         def get_config():
             return self.config
 
         namespace = dict(load_subconfig=load_subconfig, get_config=get_config)
         fs_encoding = sys.getfilesystemencoding() or 'ascii'
         conf_filename = self.full_filename.encode(fs_encoding)
         execfile(conf_filename, namespace)
 
     def _convert_to_config(self):
         if self.data is None:
             ConfigLoaderError('self.data does not exist')
 
 
 class CommandLineConfigLoader(ConfigLoader):
     """A config loader for command line arguments.
 
     As we add more command line based loaders, the common logic should go
     here.
     """
 
 kv_pattern = re.compile(r'[A-Za-z]\w*(\.\w+)*\=.+')
 macro_pattern = re.compile(r'\-\-\w+(\-\w)*')
 
 class KeyValueConfigLoader(CommandLineConfigLoader):
     """A config loader that loads key value pairs from the command line.
 
     This allows command line options to be gives in the following form::
     
         ipython Global.profile="foo" InteractiveShell.autocall=False
     """
 
     def __init__(self, argv=None, shortnames=None, macros=None):
         """Create a key value pair config loader.
 
         Parameters
         ----------
         argv : list
             A list that has the form of sys.argv[1:] which has unicode
             elements of the form u"key=value". If this is None (default),
             then sys.argv[1:] will be used.
         shortnames : dict
             A dict of aliases for configurable traits.
             Keys are the short aliases, Values are the resolved trait.
             Of the form: `{'shortname' : 'Configurable.trait'}`
         macros : dict
             A dict of macros, keyed by str name. Vaues can be Config objects,
             dicts, or "key=value" strings.  If Config or dict, when the macro
             is triggered, The macro is loaded as `self.config.update(m)`.
 
         Returns
         -------
         config : Config
             The resulting Config object.
 
         Examples
         --------
 
             >>> from IPython.config.loader import KeyValueConfigLoader
             >>> cl = KeyValueConfigLoader()
             >>> cl.load_config(["foo='bar'","A.name='brian'","B.number=0"])
             {'A': {'name': 'brian'}, 'B': {'number': 0}, 'foo': 'bar'}
         """
         if argv is None:
             argv = sys.argv[1:]
         self.argv = argv
         self.shortnames = shortnames or {}
         self.macros = macros or {}
 
     def load_config(self, argv=None, shortnames=None, macros=None):
         """Parse the configuration and generate the Config object.
 
         Parameters
         ----------
         argv : list, optional
             A list that has the form of sys.argv[1:] which has unicode
             elements of the form u"key=value". If this is None (default),
             then self.argv will be used.
         shortnames : dict
             A dict of aliases for configurable traits.
             Keys are the short aliases, Values are the resolved trait.
             Of the form: `{'shortname' : 'Configurable.trait'}`
         macros : dict
             A dict of macros, keyed by str name. Vaues can be Config objects,
             dicts, or "key=value" strings.  If Config or dict, when the macro
             is triggered, The macro is loaded as `self.config.update(m)`.
         """
         from IPython.config.configurable import Configurable
 
         self.clear()
         if argv is None:
             argv = self.argv
         if shortnames is None:
             shortnames = self.shortnames
         if macros is None:
             macros = self.macros
 
         for item in argv:
             if kv_pattern.match(item):
                 lhs,rhs = item.split('=',1)
                 # Substitute longnames for shortnames.
                 if lhs in shortnames:
                     lhs = shortnames[lhs]
                 exec_str = 'self.config.' + lhs + '=' + rhs
                 try:
                     # Try to see if regular Python syntax will work. This
                     # won't handle strings as the quote marks are removed
                     # by the system shell.
                     exec exec_str in locals(), globals()
                 except (NameError, SyntaxError):
                     # This case happens if the rhs is a string but without
                     # the quote marks.  We add the quote marks and see if
                     # it succeeds. If it still fails, we let it raise.
                     exec_str = 'self.config.' + lhs + '="' + rhs + '"'
                     exec exec_str in locals(), globals()
             elif macro_pattern.match(item):
                 # trim leading '--'
                 m = item[2:]
                 macro = macros.get(m, None)
                 if macro is None:
                     raise ValueError("Unrecognized argument: %r"%item)
                 macro = macros[m]
-                if isinstance(macro, basestring):
-                    # macro is simply a 'Class.trait=value' string
-                    exec_str = 'self.config.' + macro
-                    exec exec_str in locals(), globals()
-                elif isinstance(macro, (dict, Configurable)):
+                if isinstance(macro, (dict, Configurable)):
                     # update self.config with Config:
                     self.config.update(macros[m])
                 else:
                     raise ValueError("Invalid macro: %r"%macro)
             else:
                 raise ValueError("Invalid argument: %r"%item)
         return self.config
 
 class ArgParseConfigLoader(CommandLineConfigLoader):
     """A loader that uses the argparse module to load from the command line."""
 
     def __init__(self, argv=None, *parser_args, **parser_kw):
         """Create a config loader for use with argparse.
 
         Parameters
         ----------
 
         argv : optional, list
           If given, used to read command-line arguments from, otherwise
           sys.argv[1:] is used.
 
         parser_args : tuple
           A tuple of positional arguments that will be passed to the
           constructor of :class:`argparse.ArgumentParser`.
 
         parser_kw : dict
           A tuple of keyword arguments that will be passed to the
           constructor of :class:`argparse.ArgumentParser`.
 
         Returns
         -------
         config : Config
             The resulting Config object.
         """
         super(CommandLineConfigLoader, self).__init__()
         if argv == None:
             argv = sys.argv[1:]
         self.argv = argv
         self.parser_args = parser_args
         self.version = parser_kw.pop("version", None)
         kwargs = dict(argument_default=argparse.SUPPRESS)
         kwargs.update(parser_kw)
         self.parser_kw = kwargs
 
     def load_config(self, argv=None):
         """Parse command line arguments and return as a Config object.
 
         Parameters
         ----------
 
         args : optional, list
           If given, a list with the structure of sys.argv[1:] to parse
           arguments from. If not given, the instance's self.argv attribute
           (given at construction time) is used."""
         self.clear()
         if argv is None:
             argv = self.argv
         self._create_parser()
         self._parse_args(argv)
         self._convert_to_config()
         return self.config
 
     def get_extra_args(self):
         if hasattr(self, 'extra_args'):
             return self.extra_args
         else:
             return []
 
     def _create_parser(self):
         self.parser = ArgumentParser(*self.parser_args, **self.parser_kw)
         self._add_arguments()
 
     def _add_arguments(self):
         raise NotImplementedError("subclasses must implement _add_arguments")
 
     def _parse_args(self, args):
         """self.parser->self.parsed_data"""
         # decode sys.argv to support unicode command-line options
         uargs = []
         for a in args:
             if isinstance(a, str):
                 # don't decode if we already got unicode
                 a = a.decode(sys.stdin.encoding or 
                                             sys.getdefaultencoding())
             uargs.append(a)
         self.parsed_data, self.extra_args = self.parser.parse_known_args(uargs)
 
     def _convert_to_config(self):
         """self.parsed_data->self.config"""
         for k, v in vars(self.parsed_data).iteritems():
             exec_str = 'self.config.' + k + '= v'
             exec exec_str in locals(), globals()
 
 

IPython/config/tests/test_application.py

@@ -1,108 +1,108 b''
 """
 Tests for IPython.config.application.Application
 
 Authors:
 
 * Brian Granger
 """
 
 #-----------------------------------------------------------------------------
 #  Copyright (C) 2008-2011  The IPython Development Team
 #
 #  Distributed under the terms of the BSD License.  The full license is in
 #  the file COPYING, distributed as part of this software.
 #-----------------------------------------------------------------------------
 
 #-----------------------------------------------------------------------------
 # Imports
 #-----------------------------------------------------------------------------
 
 from unittest import TestCase
 
 from IPython.config.configurable import Configurable
 
 from IPython.config.application import (
     Application
 )
 
 from IPython.utils.traitlets import (
     Bool, Unicode, Int, Float, List
 )
 
 #-----------------------------------------------------------------------------
 # Code
 #-----------------------------------------------------------------------------
 
 class Foo(Configurable):
 
     i = Int(0, config=True, help="The integer i.")
     j = Int(1, config=True, help="The integer j.")
     name = Unicode(u'Brian', config=True, help="First name.")
 
 
 class Bar(Configurable):
 
     enabled = Bool(True, config=True, help="Enable bar.")
 
 
 class MyApp(Application):
 
     app_name = Unicode(u'myapp')
     running = Bool(False, config=True, shortname="running",
                    help="Is the app running?")
     classes = List([Bar, Foo])
     config_file = Unicode(u'', config=True, shortname="config_file",
                    help="Load this config file")
 
     shortnames = dict(i='Foo.i',j='Foo.j',name='Foo.name',
                     enabled='Bar.enabled', log_level='MyApp.log_level')
     
-    macros = dict(enable='Bar.enabled=True', disable='Bar.enabled=False')
+    macros = dict(enable={'Bar': {'enabled' : True}}, disable={'Bar': {'enabled' : False}})
 
     macro_help = dict(
             enable="""Enable bar""",
             disable="""Disable bar"""
     )
     def init_foo(self):
         self.foo = Foo(config=self.config)
 
     def init_bar(self):
         self.bar = Bar(config=self.config)
 
 
 class TestApplication(TestCase):
 
     def test_basic(self):
         app = MyApp()
         self.assertEquals(app.app_name, u'myapp')
         self.assertEquals(app.running, False)
         self.assertEquals(app.classes, [MyApp,Bar,Foo])
         self.assertEquals(app.config_file, u'')
 
     def test_config(self):
         app = MyApp()
         app.parse_command_line(["i=10","Foo.j=10","enabled=False","log_level=0"])
         config = app.config
         self.assertEquals(config.Foo.i, 10)
         self.assertEquals(config.Foo.j, 10)
         self.assertEquals(config.Bar.enabled, False)
         self.assertEquals(config.MyApp.log_level,0)
 
     def test_config_propagation(self):
         app = MyApp()
         app.parse_command_line(["i=10","Foo.j=10","enabled=False","log_level=0"])
         app.init_foo()
         app.init_bar()
         self.assertEquals(app.foo.i, 10)
         self.assertEquals(app.foo.j, 10)
         self.assertEquals(app.bar.enabled, False)
 
     def test_macro(self):
         app = MyApp()
         app.parse_command_line(["--disable"])
         app.init_bar()
         self.assertEquals(app.bar.enabled, False)
         app.parse_command_line(["--enable"])
         app.init_bar()
         self.assertEquals(app.bar.enabled, True)
     

docs/examples/core/appconfig.py

@@ -1,97 +1,98 b''
 """A simple example of how to use IPython.config.application.Application.
 
 This should serve as a simple example that shows how the IPython config
 system works. The main classes are:
 
 * IPython.config.configurable.Configurable
 * IPython.config.configurable.SingletonConfigurable
 * IPython.config.loader.Config
 * IPython.config.application.Application
 
 To see the command line option help, run this program from the command line::
 
     $ python appconfig.py -h
 
 To make one of your classes configurable (from the command line and config
 files) inherit from Configurable and declare class attributes as traits (see
 classes Foo and Bar below). To make the traits configurable, you will need
 to set the following options:
 
 * ``config``: set to ``True`` to make the attribute configurable.
 * ``shortname``: by default, configurable attributes are set using the syntax
   "Classname.attributename". At the command line, this is a bit verbose, so
   we allow "shortnames" to be declared. Setting a shortname is optional, but
   when you do this, you can set the option at the command line using the
   syntax: "shortname=value".
 * ``help``: set the help string to display a help message when the ``-h``
   option is given at the command line. The help string should be valid ReST.
 
 When the config attribute of an Application is updated, it will fire all of
 the trait's events for all of the config=True attributes.
 """
 
 import sys
 
 from IPython.config.configurable import Configurable
 from IPython.config.application import Application
 from IPython.utils.traitlets import (
     Bool, Unicode, Int, Float, List
 )
 
 
 class Foo(Configurable):
     """A class that has configurable, typed attributes.
 
     """
 
-    i = Int(0, config=True, shortname='i', help="The integer i.")
-    j = Int(1, config=True, shortname='j', help="The integer j.")
-    name = Unicode(u'Brian', config=True, shortname='name', help="First name.")
+    i = Int(0, config=True, help="The integer i.")
+    j = Int(1, config=True, help="The integer j.")
+    name = Unicode(u'Brian', config=True, help="First name.")
 
 
 class Bar(Configurable):
 
-    enabled = Bool(True, config=True, shortname="enabled", help="Enable bar.")
+    enabled = Bool(True, config=True, help="Enable bar.")
 
 
 class MyApp(Application):
 
     app_name = Unicode(u'myapp')
-    running = Bool(False, config=True, shortname="running",
+    running = Bool(False, config=True,
                    help="Is the app running?")
     classes = List([Bar, Foo])
-    config_file = Unicode(u'', config=True, shortname="config_file",
+    config_file = Unicode(u'', config=True,
                    help="Load this config file")
     
-    shortnames = dict(i='Foo.i',j='Foo.j',name='Foo.name',
+    shortnames = dict(i='Foo.i',j='Foo.j',name='Foo.name', running='MyApp.running',
                         enabled='Bar.enabled')
     
-    macros = dict(enable='Bar.enabled=True', disable='Bar.enabled=False')
+    macros = dict(enable={'Bar': {'enabled' : True}}, disable={'Bar': {'enabled' : False}})
     macro_help = dict(
             enable="""Set Bar.enabled to True""",
             disable="""Set Bar.enabled to False"""
     )
 
     def init_foo(self):
         # Pass config to other classes for them to inherit the config.
         self.foo = Foo(config=self.config)
 
     def init_bar(self):
         # Pass config to other classes for them to inherit the config.
         self.bar = Bar(config=self.config)
 
 
 
 def main():
     app = MyApp()
     app.parse_command_line()
     if app.config_file:
         app.load_config_file(app.config_file)
     app.init_foo()
     app.init_bar()
     print "app.config:"
     print app.config
+    print app.bar.enabled
 
 
 if __name__ == "__main__":
     main()