Fixing bugs in BaseIPythonApplication.

* app_name -> name.
* config_file_paths is properly typed.

IPython/config/application.py

@@ -1,241 +1,241 b''
 # encoding: utf-8
 """
 A base class for a configurable 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 copy import deepcopy
 import logging
 import sys
 
 from IPython.config.configurable import SingletonConfigurable
 from IPython.config.loader import (
     KeyValueConfigLoader, PyFileConfigLoader, Config
 )
 
 from IPython.utils.traitlets import (
     Unicode, List, Int, Enum, Dict
 )
 from IPython.utils.text import indent
 
 #-----------------------------------------------------------------------------
 # Descriptions for
 #-----------------------------------------------------------------------------
 
 flag_description = """
 Flags are command-line arguments passed as '--<flag>'.
 These take no parameters, unlike regular key-value arguments.
 They are typically used for setting boolean flags, or enabling
 modes that involve setting multiple options together.
 """.strip() # trim newlines of front and back
 
 alias_description = """
 These are commonly set parameters, given abbreviated aliases for convenience.
 They are set in the same `name=value` way as class parameters, where
 <name> is replaced by the real parameter for which it is an alias.
 """.strip() # trim newlines of front and back
 
 keyvalue_description = """
 Parameters are set from command-line arguments of the form:
 `Class.trait=value`.  Parameters will *never* be prefixed with '-'.
 This line is evaluated in Python, so simple expressions are allowed, e.g.
     `C.a='range(3)'`   For setting C.a=[0,1,2]
 """.strip() # trim newlines of front and back
 
 #-----------------------------------------------------------------------------
 # Application class
 #-----------------------------------------------------------------------------
 
 
 class ApplicationError(Exception):
     pass
 
 
 class Application(SingletonConfigurable):
     """A singleton application with full configuration support."""
 
     # The name of the application, will usually match the name of the command
     # line application
-    app_name = Unicode(u'application')
+    name = Unicode(u'application')
 
     # The description of the application that is printed at the beginning
     # of the help.
     description = Unicode(u'This is an application.')
     # default section descriptions
     flag_description = Unicode(flag_description)
     alias_description = Unicode(alias_description)
     keyvalue_description = Unicode(keyvalue_description)
     
 
     # A sequence of Configurable subclasses whose config=True attributes will
     # be exposed at the command line.
     classes = List([])
 
     # The version string of this application.
     version = Unicode(u'0.0')
 
     # The log level for the application
     log_level = Enum((0,10,20,30,40,50), default_value=logging.WARN,
                      config=True,
                      help="Set the log level (0,10,20,30,40,50).")
     
     # the alias map for configurables
     aliases = Dict(dict(log_level='Application.log_level'))
     
     # flags for loading Configurables or store_const style flags
     # flags are loaded from this dict by '--key' flags
     # this must be a dict of two-tuples, the first element being the Config/dict
     # and the second being the help string for the flag
     flags = Dict()
     
 
     def __init__(self, **kwargs):
         SingletonConfigurable.__init__(self, **kwargs)
         # Add my class to self.classes so my attributes appear in command line
         # options.
         self.classes.insert(0, self.__class__)
         
         # ensure self.flags dict is valid
         for key,value in self.flags.iteritems():
             assert len(value) == 2, "Bad flag: %r:%s"%(key,value)
             assert isinstance(value[0], (dict, Config)), "Bad flag: %r:%s"%(key,value)
             assert isinstance(value[1], basestring), "Bad flag: %r:%s"%(key,value)
         self.init_logging()
 
     def _config_changed(self, name, old, new):
         SingletonConfigurable._config_changed(self, name, old, new)
         self.log.debug('Config changed:')
         self.log.debug(repr(new))
 
     def init_logging(self):
         """Start logging for this application.
 
         The default is to log to stdout using a StreaHandler. The log level
         starts at loggin.WARN, but this can be adjusted by setting the 
         ``log_level`` attribute.
         """
         self.log = logging.getLogger(self.__class__.__name__)
         self.log.setLevel(self.log_level)
         self._log_handler = logging.StreamHandler()
         self._log_formatter = logging.Formatter("[%(name)s] %(message)s")
         self._log_handler.setFormatter(self._log_formatter)
         self.log.addHandler(self._log_handler)
 
     def _log_level_changed(self, name, old, new):
         """Adjust the log level when log_level is set."""
         self.log.setLevel(new)
     
     def print_alias_help(self):
         """print the alias part of the help"""
         if not self.aliases:
             return
             
         print "Aliases"
         print "-------"
         print self.alias_description
         print
         
         classdict = {}
         for c in self.classes:
             classdict[c.__name__] = c
         
         for alias, longname in self.aliases.iteritems():
             classname, traitname = longname.split('.',1)
             cls = classdict[classname]
             
             trait = cls.class_traits(config=True)[traitname]
             help = trait.get_metadata('help')
             print alias, "(%s)"%longname, ':', trait.__class__.__name__
             if help:
                 print indent(help)
         print
     
     def print_flag_help(self):
         """print the flag part of the help"""
         if not self.flags:
             return
         
         print "Flags"
         print "-----"
         print self.flag_description
         print
         
         for m, (cfg,help) in self.flags.iteritems():
             print '--'+m
             print indent(help)
         print
     
     def print_help(self):
         """Print the help for each Configurable class in self.classes."""
         self.print_flag_help()
         self.print_alias_help()
         if self.classes:
             print "Class parameters"
             print "----------------"
             print self.keyvalue_description
             print
         
         for cls in self.classes:
             cls.class_print_help()
             print
 
     def print_description(self):
         """Print the application description."""
         print self.description
         print
 
     def print_version(self):
         """Print the version string."""
         print self.version
 
     def update_config(self, config):
         """Fire the traits events when the config is updated."""
         # Save a copy of the current config.
         newconfig = deepcopy(self.config)
         # Merge the new config into the current one.
         newconfig._merge(config)
         # Save the combined config as self.config, which triggers the traits
         # events.
         self.config = newconfig
 
     def parse_command_line(self, argv=None):
         """Parse the command line arguments."""
         argv = sys.argv[1:] if argv is None else argv
 
         if '-h' in argv or '--help' in argv:
             self.print_description()
             self.print_help()
             self.exit(1)
 
         if '--version' in argv:
             self.print_version()
             self.exit(1)
         
         loader = KeyValueConfigLoader(argv=argv, aliases=self.aliases,
                                         flags=self.flags)
         config = loader.load_config()
         self.update_config(config)
 
     def load_config_file(self, filename, path=None):
         """Load a .py based config file by filename and path."""
         loader = PyFileConfigLoader(filename, path=path)
         config = loader.load_config()
         self.update_config(config)
 
     def exit(self, exit_status=0):
         self.log.debug("Exiting application: %s" % self.name)
         sys.exit(exit_status)

IPython/config/tests/test_application.py

@@ -1,105 +1,105 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, Dict
 )
 
 #-----------------------------------------------------------------------------
 # 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')
+    name = Unicode(u'myapp')
     running = Bool(False, config=True,
                    help="Is the app running?")
     classes = List([Bar, Foo])
     config_file = Unicode(u'', config=True,
                    help="Load this config file")
 
     aliases = Dict(dict(i='Foo.i',j='Foo.j',name='Foo.name',
                     enabled='Bar.enabled', log_level='MyApp.log_level'))
     
     flags = Dict(dict(enable=({'Bar': {'enabled' : True}}, "Set Bar.enabled to True"),
                   disable=({'Bar': {'enabled' : False}}, "Set Bar.enabled to False")))
     
     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.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_alias(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)
     

IPython/core/newapplication.py

@@ -1,132 +1,133 b''
 # encoding: utf-8
 """
 An application for IPython.
 
 All top-level applications should use the classes in this module for
 handling configuration and creating componenets.
 
 The job of an :class:`Application` is to create the master configuration 
 object and then create the configurable objects, passing the config to them.
 
 Authors:
 
 * Brian Granger
 * Fernando Perez
 
 Notes
 -----
 """
 
 #-----------------------------------------------------------------------------
 #  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 os
 import sys
 
 from IPython.config.application import Application
 from IPython.core import release, crashhandler
 from IPython.utils.path import get_ipython_dir, get_ipython_package_dir
 from IPython.utils.traitlets import Tuple, Unicode, Type
 
 #-----------------------------------------------------------------------------
 # Classes and functions
 #-----------------------------------------------------------------------------
 
 
 class BaseIPythonApplication(Application):
 
-    app_name = Unicode(u'ipython')
+    name = Unicode(u'ipython')
     description = Unicode(u'IPython: an enhanced interactive Python shell.')
     version = Unicode(release.version)
 
     # The name of the default config file. Track separately from the actual
     # name because some logic happens only if we aren't using the default.
     default_config_file_name = Unicode(u'ipython_config.py')
 
     # The directory that contains IPython's builtin profiles.
     builtin_profile_dir = Unicode(
         os.path.join(get_ipython_package_dir(), u'config', u'profile')
     )
 
-    config_file_paths = Tuple(Unicode)
+    config_file_paths = Tuple(Unicode, Unicode, Unicode)
     def _config_file_paths_default(self):
         return (os.getcwdu(), self.ipython_dir, self.builtin_profile_dir)
 
     profile_name = Unicode(u'', config=True,
         help="""The IPython profile to use."""
     )
 
     ipython_dir = Unicode(get_ipython_dir(), config=True, help=
         """
         The name of the IPython directory. This directory is used for logging
         configuration (through profiles), history storage, etc. The default
         is usually $HOME/.ipython. This options can also be specified through
         the environment variable IPYTHON_DIR.
         """
     )
 
     # The class to use as the crash handler.
     crash_handler_class = Type(crashhandler.CrashHandler)
 
     #-------------------------------------------------------------------------
     # Various stages of Application creation
     #-------------------------------------------------------------------------
 
     def init_crash_handler(self):
         """Create a crash handler, typically setting sys.excepthook to it."""
         self.crash_handler = self.crash_handler_class(self)
         sys.excepthook = self.crash_handler
 
     def _ipython_dir_changed(self, name, old, new):
         if old in sys.path:
             sys.path.remove(old)
         sys.path.append(os.path.abspath(new))
         if not os.path.isdir(new):
             os.makedirs(new, mode=0777)
         self.config_file_paths = (os.getcwdu(), new, self.builtin_profile_dir)
         self.log.debug("IPYTHON_DIR set to: %s" % new)
 
     @property
     def config_file_name(self):
         """Find the config file name for this application."""
         if self.profile_name:
             name_parts = self.default_config_file_name.split('.')
             name_parts.insert(1, u'_' + self.profile_name + u'.')
             return ''.join(name_parts)
         else:
             return self.default_config_file_name
 
     def load_config_file(self, suppress_errors=True):
         """Load the config file.
 
         By default, errors in loading config are handled, and a warning
         printed on screen. For testing, the suppress_errors option is set
         to False, so errors will make tests fail.
         """
         self.log.debug("Attempting to load config file: %s" %
                        self.config_file_name)
         try:
             Application.load_config_file(
                 self,
                 self.config_file_name, 
                 path=self.config_file_paths
             )
         except IOError:
             # Only warn if the default config file was NOT being used.
             if not self.config_file_name == self.default_config_file_name:
                 self.log.warn("Config file not found, skipping: %s" %
                                self.config_file_name, exc_info=True)
         except:
-            if not suppress_errors:     # For testing purposes
+            # For testing purposes.
+            if not suppress_errors:
                 raise
             self.log.warn("Error loading config file: %s" %
                           self.config_file_name, exc_info=True)
 

docs/examples/core/appconfig.py

@@ -1,96 +1,96 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, Dict
 )
 
 
 class Foo(Configurable):
     """A class that has configurable, typed attributes.
 
     """
 
     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')
+    name = Unicode(u'myapp')
     running = Bool(False, config=True,
                    help="Is the app running?")
     classes = List([Bar, Foo])
     config_file = Unicode(u'', config=True,
                    help="Load this config file")
     
     aliases = Dict(dict(i='Foo.i',j='Foo.j',name='Foo.name', running='MyApp.running',
                         enabled='Bar.enabled', log_level='MyApp.log_level'))
     
     flags = Dict(dict(enable=({'Bar': {'enabled' : True}}, "Enable Bar"),
                   disable=({'Bar': {'enabled' : False}}, "Disable Bar"),
                   debug=({'MyApp':{'log_level':10}}, "Set loglevel to DEBUG")
             ))
     
     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
 
 
 if __name__ == "__main__":
     main()