La classe SearchResults

La classe SearchResults représente le résultat de l'exécution d'une requête de recherche à l'aide de Index.search().

La classe SearchResults est définie dans le module google.appengine.api.search.

Constructor

Le constructeur de la classe SearchResults est défini comme suit :

class SearchResults(number_found, results=None, cursor=None)

Demander au service de recherche d'interroger un index en spécifiant les paramètres de cette requête.

Arguments

number_found

Nombre de documents trouvés pour la requête.

results

Liste des objets ScoredDocument affichés lors de l'exécution d'une requête de recherche.

cursor

Objet Cursor vous permettant de poursuivre la recherche à partir de la fin des résultats de la recherche actuelle.

Result value

Nouvelle instance de la classe SearchRequest représentant les résultats de l'exécution de Index.search().

Exceptions

TypeError

Si l'un des paramètres contient un type non valide ou si un attribut inconnu est transmis.

ValueError

Si un paramètre contient une valeur non valide.

Propriétés

Une instance de la classe SearchResults possède les propriétés suivantes :

results

Affiche la liste des objets ScoredDocument correspondant à la requête.

number_found

Affiche un nombre approximatif de documents correspondant à la requête, où QueryOptions définit le post-traitement des résultats de la recherche. Si le paramètre QueryOptions.number_found_accuracy est défini sur 100, number_found <= 100 est correct.

cursor
Pour que ce champ soit rempli, vous devez transmettre un curseur dans l'option QueryOptions de la recherche, sinon la valeur sera "None". Il affiche un objet Cursor de résultats pouvant être utilisé pour poursuivre la recherche à partir du dernier résultat. S'il n'y a plus de résultats après le résultat actuel, il affiche "None".