Pyblosxom.pyblosxom.PyBlosxom

Package Pyblosxom :: Module pyblosxom :: Class PyBlosxom

[show private | hide private]

Class PyBlosxom

This is the main class for PyBlosxom functionality. It handles initialization, defines default behavior, and also pushes the request through all the steps until the output is rendered and we're complete.

Method Summary
	`__init__(self, config, environ, data)` Sets configuration and environment.
	`cleanup(self)` Cleanup everything.
`Request`	`getRequest(self)` Returns the `Request` object.
`Response`	`getResponse(self)` Returns the `Response` object which handles all output related functionality.
	`initialize(self)` The initialize step further initializes the Request by setting additional information in the _data dict, registering plugins, and entryparsers.
	`run(self, static)` Main loop for pyblosxom.
	`runCallback(self, callback)` Generic method to run the engine for a specific callback
	`runStaticRenderer(self, incremental)` This will go through all possible things in the blog and statically render everything to the "static_dir" specified in the config file.
	`testInstallation(self)` Goes through and runs some basic tests of the installation to make sure things are working.

Method Details

init(self, config, environ, data=None)
(Constructor)

Sets configuration and environment. Creates the Request object.

Parameters:: config - A dict containing the configuration variables.
(type=dict); environ - A dict containing the environment variables.
(type=dict); data - A dict containing data variables.
(type=dict)

cleanup(self)

Cleanup everything. This should be called when Pyblosxom has done all its work. Right before exiting.

getRequest(self)

Returns the Request object.

Returns:: the request object
(type=Request)

getResponse(self)

Returns the Response object which handles all output related functionality.

Returns:: the reponse object
(type=Response)

See Also: Response

initialize(self)

The initialize step further initializes the Request by setting additional information in the _data dict, registering plugins, and entryparsers.

run(self, static=False)

Main loop for pyblosxom. This method will run the handle callback to allow registered handlers to handle the request. If nothing handles the request, then we use the default_blosxom_handler.

runCallback(self, callback='help')

Generic method to run the engine for a specific callback

runStaticRenderer(self, incremental=0)

This will go through all possible things in the blog and statically render everything to the "static_dir" specified in the config file.

This figures out all the possible path_info settings and calls self.run() a bazillion times saving each file.

Parameters:: incremental - whether (1) or not (0) to incrementally render the pages. if we're incrementally rendering pages, then we render only the ones that have changed.
(type=boolean)

testInstallation(self)

Goes through and runs some basic tests of the installation to make sure things are working.

FIXME - This could probably use some work. Maybe make this like MoinMoin's SystemInfo page?

Generated by Epydoc 2.1 on Tue Feb 7 21:43:57 2006

http://epydoc.sf.net