[3] | 1 | # (c) 2005 Ian Bicking and contributors; written for Paste (http://pythonpaste.org) |
---|
| 2 | # Licensed under the MIT license: http://www.opensource.org/licenses/mit-license.php |
---|
| 3 | class IAppInstall(object): |
---|
| 4 | |
---|
| 5 | """ |
---|
| 6 | The interface for objects in the entry point group |
---|
| 7 | ``paste.app_install`` |
---|
| 8 | """ |
---|
| 9 | |
---|
| 10 | def __init__(distribution, entry_group, entry_name): |
---|
| 11 | """ |
---|
| 12 | An object representing a specific application (the |
---|
| 13 | distribution is a pkg_resource.Distribution object), for the |
---|
| 14 | given entry point name in the given group. Right now the only |
---|
| 15 | group used for this is ``'paste.app_factory'``. |
---|
| 16 | """ |
---|
| 17 | |
---|
| 18 | def description(sys_config): |
---|
| 19 | """ |
---|
| 20 | Return a text description of the application and its |
---|
| 21 | configuration. ``sys_config`` is a dictionary representing |
---|
| 22 | the system configuration, and can be used for giving more |
---|
| 23 | explicit defaults if the application preparation uses the |
---|
| 24 | system configuration. It may be None, in which case the |
---|
| 25 | description should be more abstract. |
---|
| 26 | |
---|
| 27 | Applications are free to ignore ``sys_config``. |
---|
| 28 | """ |
---|
| 29 | |
---|
| 30 | def write_config(command, filename, sys_config): |
---|
| 31 | """ |
---|
| 32 | Write a fresh config file to ``filename``. ``command`` is a |
---|
| 33 | ``paste.script.command.Command`` object, and should be used |
---|
| 34 | for the actual operations. It handles things like simulation |
---|
| 35 | and verbosity. |
---|
| 36 | |
---|
| 37 | ``sys_config`` is (if given) a dictionary of system-wide |
---|
| 38 | configuration options. |
---|
| 39 | """ |
---|
| 40 | |
---|
| 41 | def setup_config(command, config_filename, |
---|
| 42 | config_section, sys_config): |
---|
| 43 | """ |
---|
| 44 | Set up the application, using ``command`` (to ensure simulate, |
---|
| 45 | etc). The application is described by the configuration file |
---|
| 46 | ``config_filename``. ``sys_config`` is the system |
---|
| 47 | configuration (though probably the values from it should have |
---|
| 48 | already been encorporated into the configuration file). |
---|
| 49 | """ |
---|