Pyblosxom.entries.base

Package Pyblosxom :: Package entries :: Module base

[show private | hide private]

Module Pyblosxom.entries.base

This module contains the base class for all the Entry classes. The EntryBase class is essentially the API for entries in PyBlosxom. Reading through the comments for this class will walk you through building your own EntryBase derivatives.

This module also holds a generic generate_entry function which will generate a BaseEntry with data that you provide for it.

Classes
`EntryBase`	EntryBase is the base class for all the Entry classes.

Function Summary
	`generate_entry(request, properties, data, mtime)` Takes a properties dict and a data string and generates a generic entry using the data you provided.

Variable Summary
`int`	`BIGNUM` = 2000000000
`str`	`CONTENT_KEY` = `'body'`
`str`	`DOESNOTEXIST` = `'THISKEYDOESNOTEXIST'`
`str`	`DOESNOTEXIST2` = `'THISKEYDOESNOTEXIST2'`

Function Details

generate_entry(request, properties, data, mtime)

Takes a properties dict and a data string and generates a generic entry using the data you provided.

Parameters:: request - the Request object
(type=Request); properties - the dict of properties for the entry
(type=dict); data - the data content for the entry
(type=string); mtime - the mtime tuple (as given by time.localtime()). if you pass in None, then we'll use localtime.
(type=tuple of ints)

Variable Details

BIGNUM

Type:: int
Value:: 2000000000

CONTENT_KEY

Type:: str
Value:: 'body'

DOESNOTEXIST

Type:: str
Value:: 'THISKEYDOESNOTEXIST'

DOESNOTEXIST2

Type:: str
Value:: 'THISKEYDOESNOTEXIST2'

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

http://epydoc.sf.net