Show More
@@ -1,130 +1,132 b'' | |||
|
1 | 1 | # encoding: utf-8 |
|
2 | 2 | """ |
|
3 | 3 | A base class for a configurable application. |
|
4 | 4 | |
|
5 | 5 | Authors: |
|
6 | 6 | |
|
7 | 7 | * Brian Granger |
|
8 | 8 | """ |
|
9 | 9 | |
|
10 | 10 | #----------------------------------------------------------------------------- |
|
11 | 11 | # Copyright (C) 2008-2011 The IPython Development Team |
|
12 | 12 | # |
|
13 | 13 | # Distributed under the terms of the BSD License. The full license is in |
|
14 | 14 | # the file COPYING, distributed as part of this software. |
|
15 | 15 | #----------------------------------------------------------------------------- |
|
16 | 16 | |
|
17 | 17 | #----------------------------------------------------------------------------- |
|
18 | 18 | # Imports |
|
19 | 19 | #----------------------------------------------------------------------------- |
|
20 | 20 | |
|
21 | 21 | from copy import deepcopy |
|
22 | 22 | import logging |
|
23 | 23 | import sys |
|
24 | 24 | |
|
25 | 25 | from IPython.config.configurable import SingletonConfigurable |
|
26 | 26 | from IPython.utils.traitlets import ( |
|
27 | Unicode, List, Int | |
|
27 | Unicode, List, Int, Enum | |
|
28 | 28 | ) |
|
29 | 29 | from IPython.config.loader import ( |
|
30 | 30 | KeyValueConfigLoader, PyFileConfigLoader |
|
31 | 31 | ) |
|
32 | 32 | |
|
33 | 33 | #----------------------------------------------------------------------------- |
|
34 | 34 | # Application class |
|
35 | 35 | #----------------------------------------------------------------------------- |
|
36 | 36 | |
|
37 | 37 | |
|
38 | 38 | class Application(SingletonConfigurable): |
|
39 | 39 | |
|
40 | 40 | # The name of the application, will usually match the name of the command |
|
41 | 41 | # line application |
|
42 | 42 | app_name = Unicode(u'application') |
|
43 | 43 | |
|
44 | 44 | # The description of the application that is printed at the beginning |
|
45 | 45 | # of the help. |
|
46 | 46 | description = Unicode(u'This is an application.') |
|
47 | 47 | |
|
48 | 48 | # A sequence of Configurable subclasses whose config=True attributes will |
|
49 | 49 | # be exposed at the command line (shortnames and help). |
|
50 | 50 | classes = List([]) |
|
51 | 51 | |
|
52 | 52 | # The version string of this application. |
|
53 | 53 | version = Unicode(u'0.0') |
|
54 | 54 | |
|
55 | log_level = Int(logging.WARN, config=True, shortname="log_level") | |
|
55 | # The log level for the application | |
|
56 | log_level = Enum((0,10,20,30,40,50), default_value=logging.WARN, | |
|
57 | config=True, shortname="log_level", | |
|
58 | help="Set the log level (0,10,20,30,40,50).") | |
|
56 | 59 | |
|
57 | 60 | def __init__(self, **kwargs): |
|
58 | 61 | SingletonConfigurable.__init__(self, **kwargs) |
|
59 | 62 | # Add my class to self.classes so my attributes appear in command line |
|
60 | 63 | # options. |
|
61 | 64 | self.classes.insert(0, self.__class__) |
|
62 | 65 | self.init_logging() |
|
63 | 66 | |
|
64 | 67 | def init_logging(self): |
|
65 | 68 | """Start logging for this application. |
|
66 | 69 | |
|
67 | 70 | The default is to log to stdout using a StreaHandler. The log level |
|
68 | 71 | starts at loggin.WARN, but this can be adjusted by setting the |
|
69 | 72 | ``log_level`` attribute. |
|
70 | 73 | """ |
|
71 | 74 | self.log = logging.getLogger(self.__class__.__name__) |
|
72 | 75 | self.log.setLevel(self.log_level) |
|
73 | 76 | self._log_handler = logging.StreamHandler() |
|
74 | 77 | self._log_formatter = logging.Formatter("[%(name)s] %(message)s") |
|
75 | 78 | self._log_handler.setFormatter(self._log_formatter) |
|
76 | 79 | self.log.addHandler(self._log_handler) |
|
77 | 80 | |
|
78 | 81 | def _log_level_changed(self, name, old, new): |
|
79 | 82 | """Adjust the log level when log_level is set.""" |
|
80 | 83 | self.log.setLevel(new) |
|
81 | 84 | |
|
82 | 85 | def print_help(self): |
|
83 | 86 | """Print the help for each Configurable class in self.classes.""" |
|
84 | 87 | for cls in self.classes: |
|
85 | 88 | cls.class_print_help() |
|
86 | 89 | |
|
87 | 90 | |
|
88 | 91 | def print_description(self): |
|
89 | 92 | """Print the application description.""" |
|
90 | 93 | print self.description |
|
91 | 94 | |
|
92 | 95 | |
|
93 | 96 | def print_version(self): |
|
94 | 97 | """Print the version string.""" |
|
95 | 98 | print self.version |
|
96 | 99 | |
|
97 | 100 | def update_config(self, config): |
|
98 | 101 | # Save a copy of the current config. |
|
99 | 102 | newconfig = deepcopy(self.config) |
|
100 | 103 | # Merge the new config into the current one. |
|
101 | 104 | newconfig._merge(config) |
|
102 | 105 | # Save the combined config as self.config, which triggers the traits |
|
103 | 106 | # events. |
|
104 | 107 | self.config = config |
|
105 | 108 | |
|
106 | 109 | def parse_command_line(self, argv=None): |
|
107 | 110 | """Parse the command line arguments.""" |
|
108 | if argv is None: | |
|
109 | argv = sys.argv[1:] | |
|
111 | argv = sys.argv[1:] if argv is None else argv | |
|
110 | 112 | |
|
111 | 113 | if '-h' in argv or '--h' in argv: |
|
112 | 114 | self.print_description() |
|
113 | 115 | self.print_help() |
|
114 | 116 | sys.exit(1) |
|
115 | 117 | |
|
116 | 118 | if '--version' in argv: |
|
117 | 119 | self.print_version() |
|
118 | 120 | sys.exit(1) |
|
119 | 121 | |
|
120 | 122 | loader = KeyValueConfigLoader(argv=argv, classes=self.classes) |
|
121 | 123 | config = loader.load_config() |
|
122 | 124 | self.update_config(config) |
|
123 | 125 | |
|
124 | 126 | def load_config_file(self, filename, path=None): |
|
125 | 127 | """Load a .py based config file by filename and path.""" |
|
126 | 128 | # TODO: this raises IOError if filename does not exist. |
|
127 | 129 | loader = PyFileConfigLoader(filename, path=path) |
|
128 | 130 | config = loader.load_config() |
|
129 | 131 | self.update_config(config) |
|
130 | 132 |
@@ -1,39 +1,61 b'' | |||
|
1 | """A simple example of how to use IPython.config.application.Application. | |
|
2 | ||
|
3 | This should serve as a simple example that shows how the IPython config | |
|
4 | system works. The main classes are: | |
|
5 | ||
|
6 | * IPython.config.configurable.Configurable | |
|
7 | * IPython.config.configurable.SingletonConfigurable | |
|
8 | * IPython.config.loader.Config | |
|
9 | * IPython.config.application.Application | |
|
10 | """ | |
|
11 | ||
|
1 | 12 | import sys |
|
2 | 13 | |
|
3 | 14 | from IPython.config.configurable import Configurable |
|
4 | 15 | from IPython.config.application import Application |
|
5 | 16 | from IPython.utils.traitlets import ( |
|
6 | 17 | Bool, Unicode, Int, Float, List |
|
7 | 18 | ) |
|
8 | 19 | |
|
9 | 20 | class Foo(Configurable): |
|
10 | 21 | |
|
11 | 22 | i = Int(0, config=True, shortname='i', help="The integer i.") |
|
12 | 23 | j = Int(1, config=True, shortname='j', help="The integer j.") |
|
13 | 24 | name = Unicode(u'Brian', config=True, shortname='name', help="First name.") |
|
14 | 25 | |
|
15 | 26 | |
|
16 | 27 | class Bar(Configurable): |
|
17 | 28 | |
|
18 |
enabled = Bool(True, config=True, shortname=" |
|
|
29 | enabled = Bool(True, config=True, shortname="enabled", help="Enable bar.") | |
|
19 | 30 | |
|
20 | 31 | |
|
21 | 32 | class MyApp(Application): |
|
22 | 33 | |
|
23 | 34 | app_name = Unicode(u'myapp') |
|
24 |
running = Bool(False, config=True, shortname="running", |
|
|
35 | running = Bool(False, config=True, shortname="running", | |
|
36 | help="Is the app running?") | |
|
25 | 37 | classes = List([Bar, Foo]) |
|
26 |
config_file = Unicode(u'', config=True, shortname="config |
|
|
38 | config_file = Unicode(u'', config=True, shortname="config_file", | |
|
39 | help="Load this config file") | |
|
40 | ||
|
41 | def init_foo(self): | |
|
42 | self.foo = Foo(config=self.config) | |
|
43 | ||
|
44 | def init_bar(self): | |
|
45 | self.bar = Bar(config=self.config) | |
|
46 | ||
|
27 | 47 | |
|
28 | 48 | |
|
29 | 49 | def main(): |
|
30 | 50 | app = MyApp() |
|
31 | 51 | app.parse_command_line() |
|
32 | 52 | if app.config_file: |
|
33 | 53 | app.load_config_file(app.config_file) |
|
54 | app.init_foo() | |
|
55 | app.init_bar() | |
|
34 | 56 | print "app.config:" |
|
35 | 57 | print app.config |
|
36 | 58 | |
|
37 | 59 | |
|
38 | 60 | if __name__ == "__main__": |
|
39 | 61 | main() |
General Comments 0
You need to be logged in to leave comments.
Login now