pyzim.search.SearchResult

class documentation

class SearchResult(object):

A single result of a search.

Most searches, unless they couldn't find anything, will return multiple of these as part of a SearchResultSet.

Method	`__init__`	The default constructor.
Instance Variable	`excerpt`	a short excerpt/summary, provided it is available
Instance Variable	`full_url`	the full url of the entry this result is for
Instance Variable	`likelihood`	a 0-1 value describing the match rate
Instance Variable	`result_number`	1-based index of this result in the result set
Instance Variable	`title`	title of the entry this result is for

def __init__(self, result_number, likelihood, full_url, title, excerpt=None): ¶

The default constructor.

Parameters
result_number:`int`	1-based index of this result in the result set
likelihood:`float`	a 0-1 value describing the match rate
full_url:`str`	the full url of the entry this result is for
title:`str`	title of the entry this result is for
excerpt:`str` or `None`	a short excerpt/summary, provided it is available

excerpt: str or None = ¶

a short excerpt/summary, provided it is available

full_url: str = ¶

the full url of the entry this result is for

likelihood: float = ¶

a 0-1 value describing the match rate

result_number: int = ¶

1-based index of this result in the result set

title: str = ¶

title of the entry this result is for