=wg"dZddlmZddlZddlZddlmZddlmZm Z m Z m Z ddl m Z mZmZmZddlmZmZddlmZdd lmZGd d eZGd d eZGddeZGddeZGddeZGddeZGddeZ y)zKThis module contains classes and functions related to searching the index. )divisionN)ceil)classify highlightqueryscoring) iteritems itervaluesiterkeysxrange)DocIdSetBitSet) TermNotFound) lru_cacheceZdZdZdZy)NoTermsExceptionzException raised you try to access matched terms on a :class:`Results` object was created without them. To record which terms matched in which document, you need to call the :meth:`Searcher.search` method with ``terms=True``. z,Results were created without recording termsN)__name__ __module__ __qualname____doc__messageG/var/www/horilla/myenv/lib/python3.12/site-packages/whoosh/searching.pyrr,s =GrrceZdZdZy) TimeLimitzRaised by :class:`TimeLimitedCollector` if the time limit is reached before the search finishes. If you have a reference to the collector, you can get partial results by calling :meth:`TimeLimitedCollector.results`. N)rrrrrrrrr6s   rrc(eZdZdZ ddZdZdZy) SearchContextzA container for information about the current search that may be used by the collector or the query objects to change how they operate. Nc<||_||_||_||_y)a :param needs_current: if True, the search requires that the matcher tree be "valid" and able to access information about the current match. For queries during matcher instantiation, this means they should not instantiate a matcher that doesn't allow access to the current match's value, weight, and so on. For collectors, this means they should advanced the matcher doc-by-doc rather than using shortcut methods such as all_ids(). :param weighting: the Weighting object to use for scoring documents. :param top_query: a reference to the top-level query object. :param limit: the number of results requested by the user. N) needs_current weighting top_querylimit)selfr r!r"r#s r__init__zSearchContext.__init__Fs!+"" rcN|jjd|jdS)N()) __class__r__dict__r$s r__repr__zSearchContext.__repr__Zs>>22DMMBBrc ftj|}|jj||SN)copyr*update)r$kwargsctxs rsetzSearchContext.set]s&iio F# r)FNNr)rrrrr%r,r3rrrrrAs!GK(CrrceZdZdZej dddfdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZd1dZdZdZdZd2dZdZdZdZdZdZdZ dZ!d Z"d!Z#d"Z$d3d$Z%d#e&jNdfd%Z(d#e&jNdfd&Z)dd'd#e&jNd(dfd)Z*d4d*Z+d+Z,d5d,Z- d6d-Z.d.Z/d1d/Z0 d7d0Z1y)8SearcherzkWraps an :class:`~whoosh.reading.IndexReader` object and provides methods for searching the index. TNc &||_d|_||_||_|jj |_i|_|rNtj||_ |j|_ |j|_ |j|_ n0d|_ |jj|_ i|_ i|_ t|tur ||_n||_d|_d|_|jj#sT|jj%|_|jDcgc]\}}|j'||fc}}|_dD]#}t)||t+|j|%ycc}}w)a :param reader: An :class:`~whoosh.reading.IndexReader` object for the index to search. :param weighting: A :class:`whoosh.scoring.Weighting` object to use to score found documents. :param closereader: Whether the underlying reader will be closed when the searcher is closed. :param fromindex: An optional reference to the index of the underlying reader. This is required for :meth:`Searcher.up_to_date` and :meth:`Searcher.refresh` to work. FN) stored_fieldsall_stored_fields has_vectorvector vector_aslexicon field_terms frequency doc_frequency term_infodoc_field_length corrector iter_docs)ixreader is_closed _closereader_ix doc_count_all _doccount _field_cachesweakrefrefparentschema _idf_cache _filter_cachetyper! leafreaders subsearchers is_atomic leaf_readers _subsearchersetattrgetattr) r$readerr! closereader fromindexrMroffsetnames rr%zSearcher.__init__jsO '446 !++f-DK --DK$//DO!'!5!5D DK--..DK DO!#D   ?d "&[DN&DN }}&&(#}}99;D $($4$4!6IAv$"3"3A"6!?!6D C >D D$ t < =  > !6s>F c|Sr.rr+s r __enter__zSearcher.__enter__s rc$|jyr.)close)r$exc_infos r__exit__zSearcher.__exit__s  rcT|j||j|j|S)N)r[r!rM)r)rGr!)r$rYs rrVzSearcher._subsearchers+~~f(,tE Erc<|jD] \}}||us |cSyr.)rS)r$ subsearcherssr]s r_offset_for_subsearcherz Searcher._offset_for_subsearchers(++ JB[   rcD|jr|dfgS|jS)Nr)rTrSr+s rleaf_searcherszSearcher.leaf_searcherss$ >> 1I; $$ $rc>|jjSr.)rYrTr+s rrTzSearcher.is_atomics{{}&&((rc|jduSr.)rMr+s r has_parentzSearcher.has_parents{{$&&rcF|jr|jS|S)z]Returns the parent of this searcher (if has_parent() is True), or else self. )rnrMr+s r get_parentzSearcher.get_parents ?? ;;= Krc6|jjS)z@Returns the number of UNDELETED documents in the index. )rD doc_countr+s rrrzSearcher.doc_counts}}&&((rc|jS)z[Returns the total number of documents, DELETED OR UNDELETED, in the index. )rIr+s rrHzSearcher.doc_count_alls ~~rc|jr|jj|S|jj|Sr.)rnrp field_lengthrYr$ fieldnames rruzSearcher.field_lengths; ?? ??$11)< <;;=--i8 8rc|jr|jj|S|jj|Sr.)rnrpmax_field_lengthrYrvs rryzSearcher.max_field_lengths; ?? ??$55i@ @;;=11)< d|vr|j|d<tdi|S)z>Generates a :class:`SearchContext` for this searcher. r!r)r!r)r$r1s rcontextzSearcher.contexts( f $"&..F; &v&&rc(|jddS)zWShortcut returns a SearchContext set for unscored (boolean) searching. FN)r r!)rr+s rboolean_contextzSearcher.boolean_contexts ||%4|@@rc|xs |j}|j||||}|jr|jj |||Sddlm}g}g}||f} |jD]e\} } | j} | | vs|j| |||} | j ||| }|j||j| g|s t||||||S)aReturns a :class:`whoosh.matching.Matcher` for the postings of the given term. Unlike the :func:`whoosh.reading.IndexReader.postings` method, this method automatically sets the scoring functions on the matcher from the searcher's weighting object. )qf)scorerr) MultiMatcher) r!rrTrDpostingswhoosh.matchingrrSrYappendr)r$rwtextr!r globalscorerrmatchers docoffsetstermrgr]r\rms rrzSearcher.postingss/  ''i"'E >> ==)))T,)O O 4HJt$D'+'8'8 .# V&&(19'--k9dr-RF 9d6 BAOOA&%%f- ."9d33*lC Crc||j}||f}||vr||S|jj|||}|||<|S)zCalculates the Inverse Document Frequency of the current term (calls idf() on the searcher's Weighting object). )rOr!idf)r$rwrcacherrs rrz Searcher.idf?sN4  5=; nn  y$7d  rc 8|jdi|D]}|cSy)a3Convenience method returns the stored fields of a document matching the given keyword arguments, where the keyword keys are field names and the values are terms that must appear in the field. This method is equivalent to:: searcher.stored_fields(searcher.document_number()) Where Searcher.documents() returns a generator, this function returns either a dictionary or None. Use it when you assume the given keyword arguments either match zero or one documents (i.e. at least one of the fields is a unique key). >>> stored_fields = searcher.document(path=u"/a/b") >>> if stored_fields: ... print(stored_fields['title']) ... else: ... print("There is no document with the path /a/b") Nr) documents)r$kwps rdocumentzSearcher.documentQs&* %"% AH rc R|jfd|jdi|DS)afConvenience method returns the stored fields of a document matching the given keyword arguments, where the keyword keys are field names and the values are terms that must appear in the field. Returns a generator of dictionaries containing the stored fields of any documents matching the keyword arguments. If you do not specify any arguments (``Searcher.documents()``), this method will yield **all** documents. >>> for stored_fields in searcher.documents(emailto=u"matt@whoosh.ca"): ... print("Email subject:", stored_fields['subject']) c3@K|]}j|ywr.)r7).0docnumrDs r z%Searcher.documents..xs$;&&v.;sr)rDdocument_numbers)r$rrDs @rrzSearcher.documentsis0==;3d339b9; ;rcpt|D](\}}|j|}|j|||<*yr.)r rNto_bytes)r$rkvfields r _kw_to_textzSearcher._kw_to_text{s8bM &DAqKKNENN1%BqE &rcg}t|D]*\}}|jtj||,|r%tj|j }|Stj }|Sr.)r rrTermAnd normalizeEvery)r$r subquerieskeyvalueqs r _query_for_kwzSearcher._query_for_kwsj #B- 6JC   ejje4 5 6  *%//1A Arc ~|j|t|dk(r@t|jd\}} |j j ||S|j|j||j}|jr|jSy#t $rYywxYw)a)Returns the document number of the document matching the given keyword arguments, where the keyword keys are field names and the values are terms that must appear in the field. >>> docnum = searcher.document_number(path=u"/a/b") Where Searcher.document_numbers() returns a generator, this function returns either an int or None. Use it when you assume the given keyword arguments either match zero or one documents (i.e. at least one of the fields is a unique key). :rtype: int rrN) rlenlistitemsrYfirst_idrrmatcherr is_activeid)r$rrrrs rdocument_numberzSearcher.document_numbers$  r7a< #A&DAq {{}--a33""2&..tT5I5I5KLA{{}ttv     sB00 B<;B<c d|j||j|j|S)aReturns a generator of the document numbers for documents matching the given keyword arguments, where the keyword keys are field names and the values are terms that must appear in the field. If you do not specify any arguments (``Searcher.document_numbers()``), this method will yield **all** document numbers. >>> docnums = list(searcher.document_numbers(emailto="matt@whoosh.ca")) )rdocs_for_queryr)r$rs rrzSearcher.document_numberss. ""4#5#5b#9::rc~t}|D]-\}}|jdi||i}||j|/|S)Nr)r3radd)r$uniquesdelsetr^rrs r _find_uniquezSearcher._find_uniquesN" #KD%)T)):T5M:F! 6" # rcVt|j||jS)N)size)rrrH)r$fqs r_query_to_combzSearcher._query_to_combs#d))"-D4F4F4HIIrcN|yt|ttfr|}|St|tr|j }|St|t r|j j }|St|tjr|j|}|Std|z)Nz+Don't know what to do with filter object %r) isinstancer3r Resultsdocs ResultsPageresultsrQueryrr|)r$objcs r_filter_to_combzSearcher._filter_to_combs ; cC? +AW % A[ )   "A U[[ )##C(A I!"# #rcj|jj|}|j||||S)aReturns a sorted list of suggested corrections for the given mis-typed word ``text`` based on the contents of the given field:: >>> searcher.suggest("content", "specail") ["special"] This is a convenience method. If you are planning to get suggestions for multiple words in the same field, it is more efficient to get a :class:`~whoosh.spelling.Corrector` object and use it directly:: corrector = searcher.corrector("fieldname") for word in words: print(corrector.suggest(word)) :param limit: only return up to this many suggestions. If there are not enough terms in the field within ``maxdist`` of the given word, the returned list will be shorter than this number. :param maxdist: the largest edit distance from the given word to look at. Numbers higher than 2 are not very effective or efficient. :param prefix: require suggestions to share a prefix of this length with the given word. This is often justifiable since most misspellings do not involve the first letter of the word. Using a prefix dramatically decreases the time it takes to generate the list of words. )r#maxdistprefix)rYrBsuggest)r$rwrr#rrrs rrzSearcher.suggests16 KKM # #I .yyUGFyKKrctj|j||}|D]}|j||j ||S)a3Returns the 'numterms' most important terms from the documents listed (by number) in 'docnums'. You can get document numbers for the documents your interested in with the document_number() and document_numbers() methods. "Most important" is generally defined as terms that occur frequently in the top hits but relatively infrequently in the collection as a whole. >>> docnum = searcher.document_number(path=u"/a/b") >>> keywords_and_scores = searcher.key_terms([docnum], "content") This method returns a list of ("term", score) tuples. The score may be useful if you want to know the "strength" of the key terms, however to just get the terms themselves you can just do this: >>> kws = [kw for kw, score in searcher.key_terms([docnum], "content")] :param fieldname: Look at the terms in this field. This field must store vectors. :param docnums: A sequence of document numbers specifying which documents to extract key terms from. :param numterms: Return this number of important terms. :param model: The classify.ExpansionModel to use. See the classify module. :param normalize: normalize the scores. :returns: a list of ("term", score) tuples. modelr)rExpanderrD add_documentexpanded_terms)r$docnumsrwnumtermsrrexpanderrs r key_termszSearcher.key_termssO<$$T]]IUK *F  ! !& ) *&&x9&EErctj|j||}|j||j ||S)zReturn the 'numterms' most important terms from the given text. :param numterms: Return this number of important terms. :param model: The classify.ExpansionModel to use. See the classify module. rr)rrrDadd_textr)r$rwrrrrrs rkey_terms_from_textzSearcher.key_terms_from_texts@$$T]]IUK$&&x9&EEr Fc (|r|j|||||} n|j|g||||} tj| D cgc]\} } tj|| | c} } } |j | ||t |gScc} } w)aReturns a :class:`Results` object containing documents similar to the given document, based on "key terms" in the given field:: # Get the ID for the document you're interested in docnum = search.document_number(path=u"/a/b/c") r = searcher.more_like(docnum) print("Documents like", searcher.stored_fields(docnum)["title"]) for hit in r: print(hit["title"]) :param fieldname: the name of the field to use to test similarity. :param text: by default, the method will attempt to load the contents of the field from the stored fields for the document, or from a term vector. If the field isn't stored or vectored in the index, but you have access to the text another way (for example, loading from a file or a database), you can supply it using the ``text`` parameter. :param top: the number of results to return. :param numterms: the number of "key terms" to extract from the hit and search for. Using more terms is slower but gives potentially more and more accurate results. :param model: (expert) a :class:`whoosh.classify.ExpansionModel` to use to compute "key terms". :param normalize: whether to normalize term weights. :param filter: a query, Results object, or set of docnums. The results will only contain documents that are also in the filter object. )rrr)boost)r#filtermask)rrrOrrsearchr3) r$rrwrtoprrrrktswordweightrs r more_likezSearcher.more_like s@ **9dX16)+MC..&9x', !CC HH*-/&$jjD?/ 0{{1CS&]{KK/s"B c l|dkr td|j|fd||zi|}t|||S)awThis method is Like the :meth:`Searcher.search` method, but returns a :class:`ResultsPage` object. This is a convenience function for getting a certain "page" of the results for the given query, which is often useful in web search interfaces. For example:: querystring = request.get("q") query = queryparser.parse("content", querystring) pagenum = int(request.get("page", 1)) pagelen = int(request.get("perpage", 10)) results = searcher.search_page(query, pagenum, pagelen=pagelen) print("Page %d of %d" % (results.pagenum, results.pagecount)) print("Showing results %d-%d of %d" % (results.offset + 1, results.offset + results.pagelen + 1, len(results))) for hit in results: print("%d: %s" % (hit.rank + 1, hit["title"])) (Note that results.pagelen might be less than the pagelen argument if there aren't enough results to fill a page.) Any additional keyword arguments you supply are passed through to :meth:`Searcher.search`. For example, you can get paged results of a sorted search:: results = searcher.search_page(q, 2, sortedby="date", reverse=True) Currently, searching for page 100 with pagelen of 10 takes the same amount of time as using :meth:`Searcher.search` to find the first 1000 results. That is, this method does not have any special optimizations or efficiencies for getting a page from the middle of the full results list. (A future enhancement may allow using previous page results to improve the efficiency of finding the next page.) This method will raise a ``ValueError`` if you ask for a page number higher than the number of pages in the resulting query. :param query: the :class:`whoosh.query.Query` object to match. :param pagenum: the page number to retrieve, starting at ``1`` for the first page. :param pagelen: the number of results per page. :returns: :class:`ResultsPage` rpagenum must be >= 1r#) ValueErrorrr)r$rpagenumpagelenr1rs r search_pagezSearcher.search_pageLsF` Q;34 4$++eG7W+<GG7GW55rc ddlm}|||jj}|j |}|j |fi|S)Nr) QueryParser)rN)whoosh.qparserrrDrNparser)r$ defaultfield querystringr1rqprs rfindz Searcher.finds?. dmm.B.B C HH[ !t{{1'''rc#K|r |j}n |j}|jr)|jD]\}}||D] }||z y||D]}|yw)z}Returns an iterator of document numbers for documents matching the given :class:`whoosh.query.Query` object. N) deletion_docsrrS)r$r for_deletionmethodsr]rs rrzSearcher.docs_for_querysv __FVVF   !.. * 6$Qi*F 6/)* *!,   sA#A%cddlm}||dkr td| s|s|j}nV|r|j |||}n?|s|s|r||j k\r|j |}n|j||}|r|j||| }| r|j|}|r|j|||| }| s| r|j|| | }|S) a(Low-level method: returns a configured :class:`whoosh.collectors.Collector` object based on the given arguments. You can use this object with :meth:`Searcher.search_with_collector` to search. See the documentation for the :meth:`Searcher.search` method for a description of the parameters. This method may be useful to get a basic collector object and then wrap it with another collector from ``whoosh.collectors`` or with a custom collector of your own:: # Equivalent of # results = mysearcher.search(myquery, limit=10) # but with a time limt... # Create a TopCollector c = mysearcher.collector(limit=10) # Wrap it with a TimeLimitedCollector with a time limit of # 10.5 seconds from whoosh.collectors import TimeLimitedCollector c = TimeLimitCollector(c, 10.5) # Search using the custom collector results = mysearcher.search_with_collector(myquery, c) r) collectorsrzlimit must be >= 1)r#reverse)r ) usequality)maptype)r#order) whooshr rUnsortedCollectorSortingCollectorrrUnlimitedCollector TopCollectorFacetCollectorTermsCollectorCollapseCollectorFilterCollector)r$r#sortedbyr  groupedbycollapsecollapse_limitcollapse_orderoptimizerrtermsrscoredr rs r collectorzSearcher.collectors@ &  12 2h,,.A ++HE4;,=A '%4>>;K2K--g->A''('CA ))!Y)HA ))!,A ,,Q3A-CA T**1fd;Arc j|jdi|}|j|||jS)ae Runs a :class:`whoosh.query.Query` object on this searcher and returns a :class:`Results` object. See :doc:`/searching` for more information. This method takes many keyword arguments (documented below). See :doc:`/facets` for information on using ``sortedby`` and/or ``groupedby``. See :ref:`collapsing` for more information on using ``collapse``, ``collapse_limit``, and ``collapse_order``. :param query: a :class:`whoosh.query.Query` object to use to match documents. :param limit: the maximum number of documents to score. If you're only interested in the top N documents, you can set limit=N to limit the scoring for a faster search. Default is 10. :param scored: whether to score the results. Overriden by ``sortedby``. If both ``scored=False`` and ``sortedby=None``, the results will be in arbitrary order, but will usually be computed faster than scored or sorted results. :param sortedby: see :doc:`/facets`. :param reverse: Reverses the direction of the sort. Default is False. :param groupedby: see :doc:`/facets`. :param optimize: use optimizations to get faster results when possible. Default is True. :param filter: a query, Results object, or set of docnums. The results will only contain documents that are also in the filter object. :param mask: a query, Results object, or set of docnums. The results will not contain any documents that are in the mask object. :param terms: if True, record which terms were found in each matching document. See :doc:`/searching` for more information. Default is False. :param maptype: by default, the results of faceting with ``groupedby`` is a dictionary mapping group names to ordered lists of document numbers in the group. You can pass a :class:`whoosh.sorting.FacetMap` subclass to this keyword argument to specify a different (usually faster) method for grouping. For example, ``maptype=sorting.Count`` would store only the count of documents in each group, instead of the full list of document IDs. :param collapse: a :doc:`facet ` to use to collapse the results. See :ref:`collapsing` for more information. :param collapse_limit: the maximum number of documents to allow with the same collapse key. See :ref:`collapsing` for more information. :param collapse_order: an optional ordering :doc:`facet ` to control which documents are kept when collapsing. The default (``collapse_order=None``) uses the results order (e.g. the highest scoring documents in a scored search). :rtype: :class:`Results` r)r"search_with_collectorr)r$rr1rs rrzSearcher.searchs4h DNN $V $ ""1a(yy{rcr|xs|j}|j||||jy)abLow-level method: runs a :class:`whoosh.query.Query` object on this searcher using the given :class:`whoosh.collectors.Collector` object to collect the results:: myquery = query.Term("content", "cabbage") uc = collectors.UnlimitedCollector() tc = TermsCollector(uc) mysearcher.search_with_collector(myquery, tc) print(tc.docterms) print(tc.results()) Note that this method does not return a :class:`Results` object. You need to access the collector to get a results object or other information the collector might hold after the search. :param q: a :class:`whoosh.query.Query` object to use to match documents. :param collector: a :class:`whoosh.collectors.Collector` object to feed the results into. N)rpreparerun)r$rr"rs rr$zSearcher.search_with_collectors/2+T\\^$7+ rc|j}|i}|i}i} t|D]\} } |j| | } | | | <| }|jj } | D];} |j| | } | |vs|jj | || <=||g}|j D]g} |j| j| j}| j}||vs:||f|vsA|j| j| jfiddl m }|j|||}|j||S)a Returns a corrected version of the given user query using a default :class:`whoosh.spelling.ReaderCorrector`. The default: * Corrects any words that don't appear in the index. * Takes suggestions from the words in the index. To make certain fields use custom correctors, use the ``correctors`` argument to pass a dictionary mapping field names to :class:`whoosh.spelling.Corrector` objects. Expert users who want more sophisticated correction behavior can create a custom :class:`whoosh.spelling.QueryCorrector` and use that instead of this method. Returns a :class:`whoosh.spelling.Correction` object with a ``query`` attribute containing the corrected :class:`whoosh.query.Query` object and a ``string`` attributes containing the corrected query string. >>> from whoosh import qparser, highlight >>> qtext = 'mary "litle lamb"' >>> q = qparser.QueryParser("text", myindex.schema) >>> mysearcher = myindex.searcher() >>> correction = mysearcher().correct_query(q, qtext) >>> correction.query >>> correction.string 'mary "little lamb"' >>> mysearcher.close() You can use the ``Correction`` object's ``format_string`` method to format the corrected query string using a :class:`whoosh.highlight.Formatter` object. For example, you can format the corrected string as HTML, emphasizing the changed words. >>> hf = highlight.HtmlFormatter(classname="change") >>> correction.format_string(hf) 'mary "little lamb"' :param q: the :class:`whoosh.query.Query` object to correct. :param qstring: the original user query from which the query object was created. You can pass None instead of a string, in which the second item in the returned tuple will also be None. :param correctors: an optional dictionary mapping fieldnames to :class:`whoosh.spelling.Corrector` objects. By default, this method uses the contents of the index to spell check the terms in the query. You can use this argument to "override" some fields with a different correct, for example a :class:`whoosh.spelling.GraphCorrector`. :param terms: a sequence of ``("fieldname", "text")`` tuples to correct in the query. By default, this method corrects terms that don't appear in the index. You can use this argument to override that behavior and explicitly specify the terms that should be corrected. :param maxdist: the maximum number of "edits" (insertions, deletions, subsitutions, or transpositions of letters) allowed between the original word and any suggestion. Values higher than ``2`` may be slow. :param prefix: suggested replacement words must share this number of initial characters with the original word. Increasing this even to just ``1`` can dramatically speed up suggestions, and may be justifiable since spellling mistakes rarely involve the first letter of a word. :param aliases: an optional dictionary mapping field names in the query to different field names to use as the source of spelling suggestions. The mappings in ``correctors`` are applied after this. :rtype: :class:`whoosh.spelling.Correction` r)spelling)rYr getrNnamesrB all_tokensrwrrrr)SimpleQueryCorrector correct_query)r$rqstring correctorsr rraliasesrYdrwcorr fieldnamestokenanamerr)sqcs rr.zSearcher.correct_query5s\P ?G  J (4 OIt Iy9IAiL  [[&&( # KI Iy9I *(, (?(? (J 9% K =E @ EOOU__EzzJ&E4=+FLL%//5::!>?  @ $++JwG  G,,rr.r)rrrF) rNFNNrNTNNFNT)NNr8rN)2rrrrrBM25Fr%r`rdrVrirkrTrnrprrrHruryrrrbrrYrrrrrrrrrrrrrrrBo1Modelrrrrrrr"rr$r.rrrr5r5esK*1D2>hE % )' ) 9 = J82 D  'ADB$0;$& < ;J"L<67 ))T!FF=>"*"3"3t F15"q ))U4*LX46l( *KOBF?D'+=~8t>NO(,n-rr5c^eZdZdZ d*dZdZdZdZdZdZ d Z e Z d Z d Z d Zd Zd+dZdZdZdZdZdZdZdZdZd,dZdZdZdZdZeeeZdZ dZ!ee e!Z"dZ#dZ$ee#e$Z%d Z&d!Z'ee&e'Z(d"d#e)jTd$fd%Z+d&Z,d'Z-d-d(Z.d)Z/y).raThis object is returned by a Searcher. This object represents the results of a search query. You can mostly use it as if it was a list of dictionaries, where each dictionary is the stored fields of the document at that position in the results. Note that a Results object keeps a reference to the Searcher that created it, so keeping a reference to a Results object keeps the Searcher alive and so keeps all files used by it open. Nc||_||_||_||_|xsi|_||_|xst j|_d|_ d|_ i|_ y)a :param searcher: the :class:`Searcher` object that produced these results. :param query: the original query that created these results. :param top_n: a list of (score, docnum) tuples representing the top N search results. N) searcherrtop_ndocset _facetmapsruntimer Highlighter highlighterr"_total _char_cache)r$r?rr@rA facetmapsrCrEs rr%zResults.__init__s^!   #/r &A)*?*?*A rchdt|jd|jd|jdS)Nz)rr@rrCr+s rr,zResults.__repr__s'7:4::7;vv7;||E Ercp|j|jj|_|jS)aReturns the total number of documents that matched the query. Note this may be more than the number of scored documents, given the value of the ``limit`` keyword argument to :meth:`Searcher.search`. If this Results object was created by searching with a ``limit`` keyword, then computing the exact length of the result set may be expensive for large indexes or large result sets. You may consider using :meth:`Results.has_exact_length`, :meth:`Results.estimated_length`, and :meth:`Results.estimated_min_length` to display an estimated size of the result set instead of an exact number. )rFr"countr+s r__len__zResults.__len__s, ;; ....0DK{{rc t|tro|jt|j\}}}t |||Dcgc]0}t ||j|d||j|d2c}S|t|jk\r%td|dt|jdt ||j|d||j|dScc}w)Nrrzresults[z]: Results only has z hits)rsliceindicesrr@r Hit IndexError)r$nstartstopstepis r __getitem__zResults.__getitem__s a  ! #djj/ : E4#E468djjmA.4::a=3CD8 8C O# $%s4::"899tTZZ]1-q$**Q-2BC C 8s5C+c#Ktt|jD]2}t||j|d||j|d4yw)zFYields a :class:`Hit` object for each result in ranked order. rrN)r rr@rQ)r$rWs r__iter__zResults.__iter__sQDJJ( CAdDJJqM!,aAq1AB B CsAAc&||jvS)zEReturns True if the given document number matched the query. )r)r$rs r __contains__zResults.__contains__s$$rc$|j Sr.)is_emptyr+s r __nonzero__zResults.__nonzero__s==?""rc(|jdk(S)z9Returns True if not documents matched the query. r) scored_lengthr+s rr^zResults.is_emptys!!#q((rc(d|jDS)zfReturns an iterator of (docnum, score) pairs for the scored documents in the results. c3*K|] \}}||f ywr.r)rscorers rrz Results.items..s@ME6@sr@r+s rrz Results.itemss ATZZ@@rcX|jj|j|dS)zReturns the stored fields for the document at the ``n`` th position in the results. Use :meth:`Results.docnum` if you want the raw document number instead of the stored fields. r)r?r7r@r$rSs rfieldszResults.fieldss& }}**4::a=+;<>> results = searcher.search(my_query, groupedby=["tag", "price"]) >>> results.facet_names() ["tag", "price"] >>> results.groups("tag") {"new": [12, 1, 4], "apple": [3, 10, 5], "search": [11]} If you only used one facet, you can call the method without a facet name to get the groups for the facet. >>> results = searcher.search(my_query, groupedby="tag") >>> results.groups() {"new": [12, 1, 4], "apple": [3, 10, 5, 0], "search": [11]} By default, this returns a dictionary mapping category names to a list of document numbers, in the same relative order as they appear in the results. >>> results = mysearcher.search(myquery, groupedby="tag") >>> docnums = results.groups() >>> docnums['new'] [12, 1, 4] You can then use :meth:`Searcher.stored_fields` to get the stored fields associated with a document ID. If you specified a different ``maptype`` for the facet when you searched, the values in the dictionary depend on the :class:`whoosh.sorting.FacetMap`. >>> myfacet = sorting.FieldFacet("tag", maptype=sorting.Count) >>> results = mysearcher.search(myquery, groupedby=myfacet) >>> counts = results.groups() {"new": 3, "apple": 4, "search": 1} facetrrz not in facet names )rrBrrjKeyErrorrkas_dict)r$r^s rgroupszResults.groupssR LDGOT__1E1J,,./2D  ("D$4$4$689 9t$,,..rcj|jr|jjS|jduS)zjReturns True if this results object already knows the exact number of matching documents. N)r"computes_countrFr+s rhas_exact_lengthzResults.has_exact_lengthHs- >>>>002 2;;d* *rc|jr t|S|jj|jj S)z}The estimated maximum number of matching documents, or the exact number of matching documents if it's known. )rsrr estimate_sizer?rYr+s restimated_lengthzResults.estimated_lengthRs<  "t9 66'' (<(<(>? ?rc|jr t|S|jj|jj S)z}The estimated minimum number of matching documents, or the exact number of matching documents if it's known. )rsrrestimate_min_sizer?rYr+s restimated_min_lengthzResults.estimated_min_length\s<  "t9 66++DMM,@,@,BC Crc,t|jS)aReturns the number of scored documents in the results, equal to or less than the ``limit`` keyword argument to the search. >>> r = mysearcher.search(myquery, limit=20) >>> len(r) 1246 >>> r.scored_length() 20 This may be fewer than the total number of documents that match the query, which is what ``len(Results)`` returns. )rr@r+s rrazResults.scored_lengthfs4::rc|j(t|jj|_|jS)zbReturns a set-like object containing the document numbers that matched the query. )rAr3r"all_idsr+s rrz Results.docsvs1 ;; dnn4467DK{{rctj|}tj|j|_tj|j|_|S)z4Returns a deep copy of this results object. )r/deepcopyrAr@)r$r\s rr/z Results.copys> IIdO==--- +rc&|j|dS)zReturns the score for the document at the Nth position in the list of ranked documents. If the search was not scored, this may return None. rrergs rrdz Results.scores zz!}Qrc&|j|dS)ziReturns the document number of the result at position n in the list of ranked documents. rrergs rrzResults.docnumszz!}Qrcn|jj|jj||S)N)rwexpand)rexisting_termsr?rY)r$rrws r query_termszResults.query_termss4vv$$T]]%9%9%;/8%I Irc6t|dxr t|dS)zReturns True if the search recorded which terms matched in which documents. >>> r = searcher.search(myquery) >>> r.has_matched_terms() False >>> doctermstermdocs)hasattrr+s rhas_matched_termszResults.has_matched_termsstZ(FWT:-FFrct|jstt|jj S)aSReturns the set of ``("fieldname", "text")`` tuples representing terms from the query that matched one or more of the TOP N documents (this does not report terms for documents that match the query but did not score high enough to make the top N results). You can compare this set to the terms from the original query to find terms which didn't occur in any matching documents. This is only valid if you used ``terms=True`` in the search call to record matching terms. Otherwise it will raise an exception. >>> q = myparser.parse("alfa OR bravo OR charlie") >>> results = searcher.search(q, terms=True) >>> results.terms() set([("content", "alfa"), ("content", "charlie")]) >>> q.all_terms() - results.terms() set([("content", "bravo")]) )rrr3rrjr+s r matched_termszResults.matched_termss.&%%'" "4==%%'((rc.|jjSr.rE fragmenterr+s r_get_fragmenterzResults._get_fragmenters***rc&||j_yr.rr$fs r_set_fragmenterzResults._set_fragmenters&'#rc.|jjSr.rE formatterr+s r_get_formatterzResults._get_formatters)))rc&||j_yr.rrs r_set_formatterzResults._set_formatters%&"rc.|jjSr.rErr+s r _get_scorerzResults._get_scorers&&&rc&||j_yr.r)r$r s r _set_scorerzResults._set_scorers"#rc.|jjSr.rErr+s r _get_orderzResults._get_orders%%%rc&||j_yr.r)r$os r _set_orderzResults._set_orders!"rrrTc t|sgSt|t|}|jj}t j |||}|j d|D]\}} |j| |j||S)aReturns the 'numterms' most important terms from the top 'docs' documents in these results. "Most important" is generally defined as terms that occur frequently in the top hits but relatively infrequently in the collection as a whole. :param fieldname: Look at the terms in this field. This field must store vectors. :param docs: Look at this many of the top documents of the results. :param numterms: Return this number of important terms. :param model: The classify.ExpansionModel to use. See the classify module. :returns: list of unicode strings. rNr) rminr?rYrrr@rr) r$rwrrrrrYr_rs rrzResults.key_termss 4yI4T#%%'$$VYeDET* *IAv  ! !& ) *&&x9&EErc|j}|jD]%}|d|vs |jj|'||jz|_t |j|_y)zAppends hits from 'results' (that are not already in this results object) to the end of these results. :param results: another results object. rN)rr@rrArrF)r$rritems rextendzResults.extendsdyy{MM (DAwd" !!$' (W\\^+ $++& rct|sy|j}|jDcgc] }|d|vs |}}|j|z|_||_ycc}w)zHRemoves any hits that are not also in the other results object. Nrrrr@rA)r$r otherdocsrrs rrzResults.filter sZ7| LLN "&**E$Q90DEEiikI-  Fs AAc t|sy|j}|jDcgc] }|d|vs |}}|jDcgc] }|d|vs |}}|r ||z}||_y||z}||_ycc}wcc}w)aRe-sorts the results so any hits that are also in 'results' appear before hits not in 'results', otherwise keeping their current relative positions. This does not add the documents in the other results object to this one. :param results: another results object. :param reverse: if True, lower the position of hits in the other results object instead of raising them. Nr)rrr@)r$rr rrareinnotinrs rupgradezResults.upgrades7| LLN "&**E$Q90DEE"&**I$Qy0HII EME EME FIs A;A; BBcnt|sy|j}|j}|jDcgc] }|d|vs |}}|jDcgc] }|d|vs |}}|jDcgc] }|d|vs |}}||z|_||z|z|_ycc}wcc}wcc}w)aCombines the effects of extend() and upgrade(): hits that are also in 'results' are raised. Then any hits from the other results object that are not in this results object are appended to the end. :param results: another results object. Nrr)r$rrrrrrothers rupgrade_and_extendzResults.upgrade_and_extend.s7| yy{LLN "&**E$Q90DEE"&**I$Qy0HII")--G$47$3FGGY& U]U* FIGs# B(B( B-)B-= B2 B2)NNrNr.)FNr:)0rrrrr%r,rMrXrZr\r___bool__r^rrhrkrprsrvryrarr/rdrrrrrrpropertyrrrrrrrrrrrr<rrrrrrrrrrsCG(,*E $ DC% #H) A=&0/d+@D    I G).+(/?;J*'8I'$k; /F&# Z ,E(*Q ))TF8 ' 2+rrceZdZdZddZdZdZddZdddejd dfd Z d Z d Z d Z dZdZdZdZdZdZdZdZdZddZdZdZdZddZy)rQaRepresents a single search result ("hit") in a Results object. This object acts like a dictionary of the matching document's stored fields. If for some reason you need an actual ``dict`` object, use ``Hit.fields()`` to get one. >>> r = searcher.search(query.Term("content", "render")) >>> r[0] < Hit {title = u"Rendering the scene"} > >>> r[0].rank 0 >>> r[0].docnum == 4592 True >>> r[0].score 2.52045682 >>> r[0]["title"] "Rendering the scene" >>> r[0].keys() ["title"] Nc||_|j|_|jj|_|x|_|_||_||_d|_y)a? :param results: the Results object this hit belongs to. :param pos: the position in the results list of this hit, for example pos = 0 means this is the first (highest scoring) hit. :param docnum: the document number of this hit. :param score: the score of this hit. N)rr?rYposrankrrd_fields)r$rrrrds rr%z Hit.__init__ZsO (( mm**, ""49   rc|j*|jj|j|_|jS)zbReturns a dictionary of the stored fields of the document this object represents. )rr?r7rr+s rrhz Hit.fieldsks2 << ==66t{{CDL||rc|jjst|jjj |j gS)aReturns the set of ``("fieldname", "text")`` tuples representing terms from the query that matched in this document. You can compare this set to the terms from the original query to find terms which didn't occur in this document. This is only valid if you used ``terms=True`` in the search call to record matching terms. Otherwise it will raise an exception. >>> q = myparser.parse("alfa OR bravo OR charlie") >>> results = searcher.search(q, terms=True) >>> for hit in results: ... print(hit["title"]) ... print("Contains:", hit.matched_terms()) ... print("Doesn't contain:", q.all_terms() - hit.matched_terms()) )rrrrr*rr+s rrzHit.matched_termsts;"||--/" "||$$((b99rcZ|jj}|j|||||S)a6Returns highlighted snippets from the given field:: r = searcher.search(myquery) for hit in r: print(hit["title"]) print(hit.highlights("content")) See :doc:`/highlight`. To change the fragmeter, formatter, order, or scorer used in highlighting, you can set attributes on the results object:: from whoosh import highlight results = searcher.search(myquery, terms=True) results.fragmenter = highlight.SentenceFragmenter() ...or use a custom :class:`whoosh.highlight.Highlighter` object:: hl = highlight.Highlighter(fragmenter=sf) results.highlighter = hl :param fieldname: the name of the field you want to highlight. :param text: by default, the method will attempt to load the contents of the field from the stored fields for the document. If the field you want to highlight isn't stored in the index, but you have access to the text another way (for example, loading from a file or a database), you can supply it using the ``text`` parameter. :param top: the maximum number of fragments to return. :param minscore: the minimum score for fragments to appear in the highlights. )rrminscore)rrE highlight_hit)r$rwrrrhliters r highlightszHit.highlightss7D))##D)$C-5$7 7rrrTc \|jj|j|||||||S)aReturns a new Results object containing documents similar to this hit, based on "key terms" in the given field:: r = searcher.search(myquery) for hit in r: print(hit["title"]) print("Top 3 similar documents:") for subhit in hit.more_like_this("content", top=3): print(" ", subhit["title"]) :param fieldname: the name of the field to use to test similarity. :param text: by default, the method will attempt to load the contents of the field from the stored fields for the document, or from a term vector. If the field isn't stored or vectored in the index, but you have access to the text another way (for example, loading from a file or a database), you can supply it using the ``text`` parameter. :param top: the number of results to return. :param numterms: the number of "key terms" to extract from the hit and search for. Using more terms is slower but gives potentially more and more accurate results. :param model: (expert) a :class:`whoosh.classify.ExpansionModel` to use to compute "key terms". :param normalize: whether to normalize term weights. )rrrrrr)r?rr)r$rwrrrrrrs rmore_like_thiszHit.more_like_thiss88}}&&t{{ID+.1:6'K KrcXd|jjd|jdS)N< rJ)r)rrhr+s rr,z Hit.__repr__s NN33T[[]CCrct|tr!|j|jk(St|tr|j|k(Sy)NF)rrQrhdict)r$rs r__eq__z Hit.__eq__sA eS !;;=ELLN2 2 t $;;=E) )rc4t|jSr.)rrhr+s rrMz Hit.__len__s4;;=!!rc4t|jSr.r rhr+s rrZz Hit.__iter__ &&rc||jvr|j|S|j}|j|r |j |}||j St |r.)rhrrY has_column column_readerrrn)r$rwrYcrs rrXzHit.__getitem__s_  %<< * *   Y '%%i0Bdkk? "y!!rc`||jvxs|jj|Sr.)rhrYr)r$rs rr\zHit.__contains__s,t{{}$/;;))#. 0rcPt|jjSr.)rrhrr+s rrz Hit.itemssDKKM'')**rcPt|jjSr.)rrhrjr+s rrjzHit.keyssDKKM&&())rcPt|jjSr.)rrhvaluesr+s rrz Hit.valuessDKKM((*++rc4t|jSr.)r rhr+s rr z Hit.iteritemss''rc4t|jSr.rr+s rr z Hit.iterkeysrrc4t|jSr.)r rhr+s rr zHit.itervaluess$++-((rcB|jj||Sr.)rhr*)r$rrs rr*zHit.gets{{}  g..rctdNz!You cannot modify a search resultNotImplementedErrorr$rrs r __setitem__zHit.__setitem__!"EFFrctdrrrs r __delitem__zHit.__delitem__rrctdrrr+s rclearz Hit.clear rrc tdrr)r$rr1s rr0z Hit.update rr)NN)Nrr.)rrrrr%rhrrrr<rr,rrMrZrXr\rrjrr r r r*rrrr0rrrrQrQDs*":*$7L.2rA%..$tK@D"' "0+*,(')/GGGGrrQcBeZdZdZd dZdZdZdZdZdZ dZ d Z y ) raRepresents a single page out of a longer list of results, as returned by :func:`whoosh.searching.Searcher.search_page`. Supports a subset of the interface of the :class:`~whoosh.searching.Results` object, namely getting stored fields with __getitem__ (square brackets), iterating, and the ``score()`` and ``docnum()`` methods. The ``offset`` attribute contains the results number this page starts at (numbered from 0). For example, if the page length is 10, the ``offset`` attribute on the second page will be ``10``. The ``pagecount`` attribute contains the number of pages available. The ``pagenum`` attribute contains the page number. This may be less than the page you requested if the results had too few pages. For example, if you do:: ResultsPage(results, 5) but the results object only contains 3 pages worth of hits, ``pagenum`` will be 3. The ``pagelen`` attribute contains the number of results on this page (which may be less than the page length you requested if this is the last page of the results). The ``total`` attribute contains the total number of hits in the results. >>> mysearcher = myindex.searcher() >>> pagenum = 2 >>> page = mysearcher.find_page(pagenum, myquery) >>> print("Page %s of %s, results %s to %s of %s" % ... (pagenum, page.pagecount, page.offset+1, ... page.offset+page.pagelen, page.total)) >>> for i, fields in enumerate(page): ... print("%s. %r" % (page.offset + i + 1, fields)) >>> mysearcher.close() To set highlighter attributes (for example ``formatter``), access the underlying :class:`Results` object:: page.results.formatter = highlight.UppercaseFormatter() cV||_t||_|dkr tdt t |j|z |_t|j ||_|jdz |z}||z|jkDr|j|z }||_ ||_ y)z :param results: a :class:`~whoosh.searching.Results` object. :param pagenum: which page of the results to use, numbered from ``1``. :param pagelen: the number of hits per page. rrN) rrtotalrintr pagecountrrr]r)r$rrrr]s rr%zResultsPage.__init__>s \ Q;34 4T$**w"6784>>73 ,,"g- W  *jj6)G  rc |j}t|trK|j|j\}}}|j j t||z||z|S|j j ||zSr.)r]rrOrPrrrX)r$rSr]rTrUrVs rrXzResultsPage.__getitem__Tsy a  ! $,, 7 E4<<++E%&.26--GH H<<++AJ7 7rctt|j|j|j|jzSr.)iterrr]rr+s rrZzResultsPage.__iter__]s)DLLT[[4<<-GHIIrc|jSr.)rr+s rrMzResultsPage.__len__`s zzrc6|jjSr.)rrar+s rrazResultsPage.scored_lengthcs||))++rcR|jj||jzS)zGReturns the score of the hit at the nth position on this page. )rrdr]rgs rrdzResultsPage.scorefs!||!!!dkk/22rcR|jj||jzS)zYReturns the document number of the hit at the nth position on this page. )rrr]rgs rrzResultsPage.docnumks!||""1t{{?33rcV|jdk(xs|j|jk(S)zIReturns True if this object represents the last page of results. r)rrr+s r is_last_pagezResultsPage.is_last_pageqs%~~"Ddlldnn&DDrNr9) rrrrr%rXrZrMrardrrrrrrrs2*X,8J,3 4 Err)!r __future__rr/rKmathrrrrrr whoosh.compatr r r r whoosh.idsetsr rwhoosh.readingrwhoosh.util.cacherr|rrobjectrr5rrQrrrrrs8 66AA*''=y=  FH~ -v~ -B[+f[+| JG&JGZdE&dEr