New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Config5 #400
Merged
Merged
Config5 #400
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
58fc715
Added KeyValueConfigLoader with tests.
ellisonbg 7a726af
Starting help in InteractiveShell.
ellisonbg 939184c
Started to move config docs to objects.
ellisonbg 4999878
Ongoing work on the config system.
ellisonbg 6c3563d
Created config.application and updated Configurable.
ellisonbg e766cc8
Added new tests for config.loader and configurable.
ellisonbg a8f1082
Added SingletonConfigurable with instance method.
ellisonbg a93fd45
Made InteractiveShell a SingletonConfigurable.
ellisonbg 6e90172
IPython.config.application.Application updates.
ellisonbg 605614c
Added tests for IPython.config.application.Application
ellisonbg 4a3f8d5
Adding more documentation to config.application related files.
ellisonbg File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,134 @@ | ||
# 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.utils.traitlets import ( | ||
Unicode, List, Int, Enum | ||
) | ||
from IPython.config.loader import ( | ||
KeyValueConfigLoader, PyFileConfigLoader | ||
) | ||
|
||
#----------------------------------------------------------------------------- | ||
# Application class | ||
#----------------------------------------------------------------------------- | ||
|
||
|
||
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') | ||
|
||
# The description of the application that is printed at the beginning | ||
# of the help. | ||
description = Unicode(u'This is an application.') | ||
|
||
# A sequence of Configurable subclasses whose config=True attributes will | ||
# be exposed at the command line (shortnames and help). | ||
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, shortname="log_level", | ||
help="Set the log level (0,10,20,30,40,50).") | ||
|
||
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__) | ||
self.init_logging() | ||
|
||
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_help(self): | ||
"""Print the help for each Configurable class in self.classes.""" | ||
for cls in self.classes: | ||
cls.class_print_help() | ||
|
||
def print_description(self): | ||
"""Print the application description.""" | ||
print self.description | ||
|
||
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 = config | ||
|
||
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 '--h' in argv: | ||
self.print_description() | ||
self.print_help() | ||
sys.exit(1) | ||
|
||
if '--version' in argv: | ||
self.print_version() | ||
sys.exit(1) | ||
|
||
loader = KeyValueConfigLoader(argv=argv, classes=self.classes) | ||
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.""" | ||
# TODO: this raises IOError if filename does not exist. | ||
loader = PyFileConfigLoader(filename, path=path) | ||
config = loader.load_config() | ||
self.update_config(config) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
'--help' should probably trigger here as well.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That is, it should probably be '-h', '--help'. I don't think anyone expects '--' with abbreviated names.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep