pyzim.search.BaseSearch

class documentation

class BaseSearch(object):

Known subclasses: pyzim.search.TitleStartSearch, pyzim.search.XapianSearch

Constructor: BaseSearch(zim)

Base class for search and suggestion implementations.

Method	`__init__`	The default constructor.
Method	`close`	Perform any necessary cleanup.
Method	`search`	Perform a search.
Method	`search_in_range`	Perform a range-limited search.
Instance Variable	`zim`	the ZIM archive this search is for

def __init__(self, zim): ¶

overridden in pyzim.search.TitleStartSearch, pyzim.search.XapianSearch

The default constructor.

Parameters
zim:`pyzim.archive.Zim`	the ZIM archive this search is for

def close(self): ¶

overridden in pyzim.search.XapianSearch

Perform any necessary cleanup.

This should be called before the instance is dismissed.

def search(self, term): ¶

overridden in pyzim.search.TitleStartSearch, pyzim.search.XapianSearch

Perform a search.

Parameters
term:`str`	term to search for

Returns
`SearchResultSet`	an object containing the search results

def search_in_range(self, term, start=None, n=20): ¶

overridden in pyzim.search.TitleStartSearch, pyzim.search.XapianSearch

Perform a range-limited search.

This function is primarily a helper function used by SearchResultSet to iteratively fetch new results, but it can still be used independently. Just beware of the different return type.

Parameters
term:`str`	term to search for
start:`int`	start (1-based index) of the results to find
n:`int`	number of results to fetch

Returns
`list` of `SearchResult`	an object containing the search results

zim: pyzim.archive.Zim = ¶

the ZIM archive this search is for