← Back to branch summary

~ausimage/soovee/trunk

« back to all changes in this revision

Viewing changes to soovee_app/forms/htm2format.py

  • Committer: Jeremy AustinBardo
  • Date: 2009-06-11 01:31:26 UTC
  • Revision ID: tjaustinbardo@gmail.com-20090611013126-0g4axgnvbif9y3og
Fix bugs with shelf creation and stray copy paste errors. Adjusted epydoc comments to more

Show diffs side-by-side

added added

removed removed

Lines of Context:
soovee_app/forms/htm2format.py
22
22
This plugin was developed specificaly for soovee.gui summary view. It lacks the 
23
23
cover image and sets a few class attributes as well.
24
24
 
25
 
    - C{Format.write(filename:str, workstore:str, data:list, cache=None:obj, 
26
 
        rx=None:obj) -> None}
27
 
    - C{Format.item(item:dict, feed=None:dict, rx=None:obj) -> None}
 
25
    - C{write(filepath:str, workpath:str, data:list, cache:obj=None, 
 
26
        service:obj=None) -> None}
 
27
    - C{item(item:dict, feed:dict=None, service:obj=None) -> str}
28
28
 
29
 
@requires: soovee.lib.sv_Data
 
29
@requires: L{soovee_lib.parse}
30
30
"""
31
31
METHOD = ("frm","view") #: Tuple of type and format
32
32
FILENAME = "index.html" #: Default file name for index
37
37
    Initialize and write set of html pages in ./books with an index. The 
38
38
    passed Opml data is used to retrieve the data for each Rss feed.
39
39
 
40
 
    @param filename: Local path-filename fragment.
41
 
    @type filename: basestring
42
 
    @param workstore: Base path-filename to store filename under.
43
 
    @type workstore: basestring
 
40
    @param filepath: Local path-filename fragment.
 
41
    @type filepath: basestring
 
42
    @param workpath: Base path-filename to store filename under.
 
43
    @type workpath: basestring
44
44
    @param data: List of Opml feed data to help build pages and locate Rss 
45
45
        feed data.
46
46
    @type data: list
47
47
    @param cache: Intialized soovee.lib.sv_read object. Default None.
48
48
    @type cache: obj
49
 
    @param rx: Intialized soovee.regex object. Default None.
50
 
    @type rx: obj
 
49
    @param service: Intialized soovee.regex object. Default None.
 
50
    @type service: obj
51
51
    @return:
52
52
    @rtype: None
53
 
    @requires: L{soovee.lib.sv_file}
 
53
    @requires: L{soovee_lib.parse}
54
54
    @raise TypeError: data passed was not a list
55
55
    """
56
56
    if not isinstance(data, list): 
91
91
    feed entry and in its Rss file. Store a filename for this page. Set 
92
92
    class attributes for use with soovee.gui summary view.
93
93
 
94
 
    @param item: Opml data
95
 
    @type item: dict
 
94
    @param data: Opml data
 
95
    @type data: dict
96
96
    @param feed: Rss data. Default dict.
97
97
    @type feed: dict
98
 
    @param rx: Intialized soovee.regex object. Default None.
99
 
    @type rx: obj
 
98
    @param service: Intialized soovee.regex object. Default None.
 
99
    @type service: obj
100
100
    @return:
101
101
    @rtype: basestring
102
102
    @raise TypeError: item or feed passed was not a dict