cheesecake.cheesecake_index.FilesIndex

Package cheesecake :: Module cheesecake_index :: Class FilesIndex

[show private | hide private]

Type FilesIndex

object --+    
         |    
     Index --+
             |
            FilesIndex

Known Subclasses:: IndexRequiredFiles, IndexSetupPy

Method Summary
	`get_not_used(self, files_rules)` Get only these of files_rules that didn't match during computation.
	`get_score(self, name, specs)`
	`match_filename(self, name, rule)` Check if `name` matches given `rule`.
Inherited from Index
	`__init__(self, *indices)`
	`__getitem__(self, name)`
	`add_info(self, info_line)` Add information about index computation process, which will be visible with --verbose flag.
	`add_subindex(self, index)` Add subindex.
	`compute(self)` Compute index value and return it.
	`decide(self, cheesecake, when)` Decide if this index should be computed.
	`decide_after_download(self, cheesecake)`
	`decide_before_download(self, cheesecake)`
	`get_info(self)`
	`print_info(self)` Print index name padded with dots, followed by value and details.
	`remove_subindex(self, index_name)` Remove subindex (refered by name).
Inherited from object
	`__delattr__(...)` x.__delattr__('name') <==> del x.name
	`__getattribute__(...)` x.__getattribute__('name') <==> x.name
	`__hash__(x)` x.__hash__() <==> hash(x)
	`__new__(T, S, ...)` T.__new__(S, ...) -> a new object with type S, a subtype of T
	`__reduce__(...)` helper for pickle
	`__reduce_ex__(...)` helper for pickle
	`__repr__(x)` x.__repr__() <==> repr(x)
	`__setattr__(...)` x.__setattr__('name', value) <==> x.name = value
	`__str__(x)` x.__str__() <==> str(x)

Property Summary
Inherited from Index
	`max_value`
	`requirements`

Class Variable Summary
`str`	`name` = `'FilesIndex'`
Inherited from Index
`str`	`details` = `''`
`str`	`info` = `''`
`NoneType`	`subindices` = None
`int`	`value` = -1

Method Details

get_not_used(self, files_rules)

Get only these of files_rules that didn't match during computation.

>>> rules = {
...     Doc('readme'): 30,
...     OneOf(Doc('license'), Doc('copying')): 30,
...     'demo': 10,
... }
>>> index = FilesIndex()
>>> index._used_rules.append('demo')
>>> map(lambda x: str(x), index.get_not_used(rules.keys()))
['license/license.html/license.txt/copying/copying.html/copying.txt', 'readme/readme.html/readme.txt']

match_filename(self, name, rule)

Check if name matches given rule.

Class Variable Details

name

Type:: str
Value:: 'FilesIndex'

Generated by Epydoc 2.1 on Fri Feb 9 02:15:12 2007

http://epydoc.sf.net