WebKit.AutoReloadingAppServer | index /usr/local/share/webware/WebKit/AutoReloadingAppServer.py

`AutoReloadingAppServer
This module defines `AutoReloadingAppServer`, a replacement for `AppServer`
that adds a file-monitoring and restarting to the AppServer. Used mostly like::
from AutoReloadingAppServer import AutoReloadingAppServer as AppServer
If `UseImportSpy` is set to False in AppServer.config, or FAM support is
not available, this requires regular polling. The interval for the polling
in seconds can be set with `AutoReloadPollInterval` in AppServer.config.`

Modules
`` |  |
os | select | sys | time

Classes
`` |  | WebKit.AppServer.AppServer(WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath, WebKit.Object.Object) AutoReloadingAppServer
class AutoReloadingAppServer(WebKit.AppServer.AppServer)
`` | `AppServer AutoReloading. This class adds functionality to `AppServer`, to notice changes to source files, including servlets, PSPs, templates or changes to the Webware source file themselves, and reload the server as necessary to pick up the changes. The server will also be restarted if a file which Webware *tried* to import is modified. This is so that changes to a file containing a syntax error (which would have prevented it from being imported) will also cause the server to restart.`
| Method resolution order: AutoReloadingAppServer WebKit.AppServer.AppServer WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath MiscUtils.Configurable.Configurable WebKit.Object.Object __builtin__.object MiscUtils.NamedValueAccess.NamedValueAccess Methods defined here: __init__(self, path=None) `Activate AutoReloading.` activateAutoReload(self) `Start the monitor thread.` deactivateAutoReload(self) `Tell the monitor thread to stop. This should be considered as a request, not a demand.` defaultConfig(self) `Return the default configuration.` fileMonitorThreadLoop(self) `This the the main loop for the monitoring thread. Runs in its own thread, polling the files for changes directly (i.e., going through every file that's being used and checking its last-modified time, seeing if it's been changed since it was initially loaded).` fileMonitorThreadLoopFAM(self, getmtime=<function getmtime>) `Monitoring thread loop, but using the FAM library.` monitorNewModule(self, filepath, mtime=None) `Add new file to be monitored. This is a callback which ImportSpy invokes to notify us of new files to monitor. This is only used when we are using FAM.` restart(self) `Do the actual restart. Call `shouldRestart` from outside the class.` restartIfNecessary(self) `Check if the app server should be restarted. This should be called regularly to see if a restart is required. The server can only restart from the main thread, other threads can't do the restart. So this polls to see if `shouldRestart` has been called.` shouldRestart(self) `Tell the main thread to restart the server.` shutDown(self) `Shut down the monitoring thread. This is done in addition to the normal shutdown procedure.` Methods inherited from WebKit.AppServer.AppServer: application(self) `Return the Application singleton.` checkForInstall(self) `Check whether Webware was installed. Exits with an error message if Webware was not installed. Called from `__init__`.` closeThread(self) `This method is called when the shutdown sequence is initiated.` configFilename(self) `Return the name of the AppServer configuration file.` configReplacementValues(self) `Get config values that need to be escaped.` createApplication(self) `Create and return an application object. Invoked by __init__.` error(self, msg) `Output an error. Flushes stdout and stderr, prints the message to stderr and exits with code 1.` initiateShutdown(self) `Ask the master thread to begin the shutdown.` isPersistent(self) `Check whether the AppServer is persistent. When using ``OneShot``, the AppServer will exist only for a single request, otherwise it will stay around indefinitely.` loadPlugIn(self, path) `Load and return the given plug-in. May return None if loading was unsuccessful (in which case this method prints a message saying so). Used by `loadPlugIns` (note the **s**).` loadPlugIns(self) `Load all plug-ins. A plug-in allows you to extend the functionality of WebKit without necessarily having to modify its source. Plug-ins are loaded by AppServer at startup time, just before listening for requests. See the docs in `WebKit.PlugIn` for more info.` numRequests(self) `Return the number of requests. Returns the number of requests received by this app server since it was launched.` plugIn(self, name, default=<class MiscUtils.NoDefault>) `Return the plug-in with the given name.` plugIns(self) `Return a list of the plug-ins loaded by the app server. Each plug-in is a Python package.` printStartUpMessage(self) `Invoked by __init__, prints a little intro.` readyForRequests(self) `Declare ready for getting requests. Should be invoked by subclasses when they are finally ready to accept requests. Records some stats and prints a message.` recordPID(self) `Save the pid of the AppServer to a file.` serverSidePath(self, path=None) `Return the absolute server-side path of the WebKit app server. If the optional path is passed in, then it is joined with the server side directory to form a path relative to the app server.` startTime(self) `Return the time the app server was started. The time is given as seconds, like time().` version(self) `Return WebKit version.` warning(self, msg) `Output a warning (not yet implemented).` webKitPath(self) `Return teh WebKit path.` webwarePath(self) `Return the Webware path.` Methods inherited from WebKit.ConfigurableForServerSidePath.ConfigurableForServerSidePath: setting(self, name, default=<class MiscUtils.NoDefault>) `Returns the setting, filtered by serverSidePath(), if the name ends with ``Filename`` or ``Dir``.` Methods inherited from MiscUtils.Configurable.Configurable: commandLineConfig(self) `Settings that came from the command line (via addCommandLineSetting).` config(self) `Returns the configuration of the object as a dictionary. This is a combination of defaultConfig() and userConfig(). This method caches the config.` configName(self) `Returns the name of the configuration file (the portion before the '.config'). This is used on the command-line.` hasSetting(self, name) printConfig(self, dest=None) `Prints the configuration to the given destination, which defaults to stdout. A fixed with font is assumed for aligning the values to start at the same column.` setSetting(self, name, value) userConfig(self) `Returns the user config overrides found in the optional config file, or {} if there is no such file. The config filename is taken from configFilename().` Methods inherited from WebKit.Object.Object: deprecated(self, method) `Output a deprecation warning. The implementation of WebKit sometimes invokes this method which prints a warning that the method you are using has been deprecated. This method expects that deprecated methods say so at the beginning of their doc string and terminate that msg with @. For example: DEPRECATED: Class.foo() on 01/24/01 in ver 0.5. Use Class.bar() instead. @ Putting this information in the doc string is important for accuracy in the generated docs. Example call: deprecated(self.foo)` Data and other attributes inherited from WebKit.Object.Object: __dict__ = <dictproxy object> `dictionary for instance variables (if defined)` __weakref__ = <attribute '__weakref__' of 'Object' objects> `list of weak references to the object (if defined)` Methods inherited from MiscUtils.NamedValueAccess.NamedValueAccess: hasValueForKey(self, key) `Returns true if the key is available, although that does not guarantee that there will not be errors caused by retrieving the key.` hasValueForName(self, keysString) resetKeyBindings(self) setValueForKey(self, key, value) `Suppose key is 'foo'. This method sets the value with the following precedence: 1. Public attributes before private attributes 2. Methods before non-methods More specifically, this method then uses one of the following: @@ 2000-03-04 ce: fill in ...or invokes handleUnknownSetKey().` valueForKey(self, key, default=<class MiscUtils.NoDefault>) `Suppose key is 'foo'. This method returns the value with the following precedence: 1. Methods before non-methods 2. Public attributes before private attributes More specifically, this method then returns one of the following: * foo() * _foo() * self.foo * self._foo ...or default, if it was specified, otherwise invokes and returns result of valueForUnknownKey(). Note that valueForUnknownKey(), normally returns an exception. See valueForName() which is a more advanced version of this method that allows multiple, qualified keys.` valueForKeySequence(self, listOfKeys, default=None) valueForName(self, keysString, default=None) `Returns the value for the given keysString. This is the more advanced version of valueForKey(), which can only handle single names. This method can handle 'foo', 'foo1.foo2', 'a.b.c.d', etc. It will traverse dictionaries if needed.` valueForUnknownKey(self, key, default) `# Errors` valuesForNames(self, keys, default=None, defaults=None, forgive=0, includeNames=0) `Returns a list of values that match the given keys, each of which is passed through valueForName() and so could be of the form 'a.b.c'. keys is a sequence. default is any kind of object. defaults is a sequence. forgive and includeNames is a flag. If default is not None, then it is substituted when a key is not found. Otherwise, if defaults is not None, then it's corresponding/parallel value for the current key is substituted when a key is not found. Otherwise, if forgive=1, then unknown keys simply don't produce any values. Otherwise, if default and defaults are None, and forgive=0, then the unknown keys will probably raise an exception through valueForUnknownKey() although that method can always return a final, default value. if keys is None, then None is returned. If keys is an empty list, then None is returned. Often these last four arguments are specified by key. Examples: names = ['origin.x', 'origin.y', 'size.width', 'size.height'] obj.valuesForNames(names) obj.valuesForNames(names, default=0.0) obj.valuesForNames(names, defaults=[0.0, 0.0, 100.0, 100.0]) obj.valuesForNames(names, forgive=0) @@ 2000-03-04 ce: includeNames is only supported when forgive=1. It should be supported for the other cases. It should be documented. It should be included in the test cases.`

Data
`` |  | DefaultConfig = {'AutoReload': False, 'AutoReloadPollInterval': 1, 'UseImportSpy': 1}