From b0a75052539976989753776bd6066670d9a0dfde Mon Sep 17 00:00:00 2001 From: Daniel Lindsley Date: Sun, 8 May 2011 23:21:14 -0500 Subject: [PATCH 01/14] Updated Xapian for the multiple indexes support in Haystack 2.X. --- tests/xapian_settings.py | 10 +- tests/xapian_tests/tests/xapian_backend.py | 140 ++++++++++----------- tests/xapian_tests/tests/xapian_query.py | 8 +- xapian_backend.py | 104 +++++++-------- 4 files changed, 122 insertions(+), 140 deletions(-) diff --git a/tests/xapian_settings.py b/tests/xapian_settings.py index f5732bb..203056d 100755 --- a/tests/xapian_settings.py +++ b/tests/xapian_settings.py @@ -7,6 +7,10 @@ INSTALLED_APPS += [ 'xapian_tests', ] -HAYSTACK_SEARCH_ENGINE = 'xapian' -HAYSTACK_XAPIAN_PATH = os.path.join('tmp', 'test_xapian_query') -HAYSTACK_INCLUDE_SPELLING = True +HAYSTACK_CONNECTIONS = { + 'default': { + 'ENGINE': 'haystack.backends.xapian_backend.XapianEngine', + 'PATH': os.path.join('tmp', 'test_xapian_query'), + 'INCLUDE_SPELLING': True, + } +} diff --git a/tests/xapian_tests/tests/xapian_backend.py b/tests/xapian_tests/tests/xapian_backend.py index 0d7e49f..e1e6f0b 100644 --- a/tests/xapian_tests/tests/xapian_backend.py +++ b/tests/xapian_tests/tests/xapian_backend.py @@ -12,12 +12,13 @@ from django.conf import settings from django.db import models from django.test import TestCase -from haystack import indexes, sites, backends -from haystack.backends.xapian_backend import SearchBackend, SearchQuery, _marshal_value +from haystack import connections, reset_search_queries +from haystack import indexes +from haystack.backends.xapian_backend import _marshal_value from haystack.exceptions import HaystackError from haystack.models import SearchResult from haystack.query import SearchQuerySet, SQ -from haystack.sites import SearchSite +from haystack.utils.loading import UnifiedIndex from core.models import MockTag, MockModel, AnotherMockModel, AFourthMockModel from core.tests.mocks import MockSearchResult @@ -67,6 +68,9 @@ class XapianMockSearchIndex(indexes.SearchIndex): keys = indexes.MultiValueField() titles = indexes.MultiValueField() + def get_model(self): + return XapianMockModel + def prepare_sites(self, obj): return ['%d' % (i * obj.id) for i in xrange(1, 4)] @@ -105,16 +109,21 @@ class XapianBoostMockSearchIndex(indexes.SearchIndex): author = indexes.CharField(model_attr='author', weight=2.0) editor = indexes.CharField(model_attr='editor') pub_date = indexes.DateField(model_attr='pub_date') + + def get_model(self): + return AFourthMockModel class XapianSearchBackendTestCase(TestCase): def setUp(self): super(XapianSearchBackendTestCase, self).setUp() - self.site = SearchSite() - self.backend = SearchBackend(site=self.site) - self.index = XapianMockSearchIndex(XapianMockModel, backend=self.backend) - self.site.register(XapianMockModel, XapianMockSearchIndex) + self.old_ui = connections['default'].get_unified_index() + self.ui = UnifiedIndex() + self.index = XapianMockSearchIndex() + self.ui.build(indexes=[self.index]) + self.backend = connections['default'].get_backend() + connections['default']._index = self.ui self.sample_objs = [] @@ -134,9 +143,10 @@ class XapianSearchBackendTestCase(TestCase): self.sample_objs[2].popularity = 972.0 def tearDown(self): - if os.path.exists(settings.HAYSTACK_XAPIAN_PATH): - shutil.rmtree(settings.HAYSTACK_XAPIAN_PATH) + if os.path.exists(settings.HAYSTACK_CONNECTIONS['default']['PATH']): + shutil.rmtree(settings.HAYSTACK_CONNECTIONS['default']['PATH']) + connections['default']._index = self.old_ui super(XapianSearchBackendTestCase, self).tearDown() def test_update(self): @@ -310,36 +320,6 @@ class XapianSearchBackendTestCase(TestCase): # Ensure that swapping the ``result_class`` works. self.assertTrue(isinstance(self.backend.more_like_this(self.sample_objs[0], result_class=MockSearchResult)['results'][0], MockSearchResult)) - def test_use_correct_site(self): - test_site = SearchSite() - test_site.register(XapianMockModel, XapianMockSearchIndex) - self.backend.update(self.index, self.sample_objs) - - # Make sure that ``_process_results`` uses the right ``site``. - self.assertEqual(self.backend.search(xapian.Query('indexed'))['hits'], 3) - self.assertEqual([result.pk for result in self.backend.search(xapian.Query('indexed'))['results']], [1, 2, 3]) - - self.site.unregister(XapianMockModel) - self.assertEqual(len(self.site.get_indexed_models()), 0) - self.backend.site = test_site - self.assertTrue(len(self.backend.site.get_indexed_models()) > 0) - - # Should still be there, despite the main ``site`` not having that model - # registered any longer. - self.assertEqual(self.backend.search(xapian.Query('indexed'))['hits'], 3) - self.assertEqual([result.pk for result in self.backend.search(xapian.Query('indexed'))['results']], [1, 2, 3]) - - # Unregister it on the backend & make sure it takes effect. - self.backend.site.unregister(XapianMockModel) - self.assertEqual(len(self.backend.site.get_indexed_models()), 0) - self.assertEqual(self.backend.search(xapian.Query('indexed'))['hits'], 0) - - # Nuke it & fallback on the main ``site``. - self.backend.site = haystack.site - self.assertEqual(self.backend.search(xapian.Query('indexed'))['hits'], 0) - self.site.register(XapianMockModel, XapianMockSearchIndex) - self.assertEqual(self.backend.search(xapian.Query('indexed'))['hits'], 3) - def test_order_by(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) @@ -395,7 +375,7 @@ class XapianSearchBackendTestCase(TestCase): self.assertEqual(_marshal_value(datetime.datetime(2009, 5, 18, 1, 16, 30, 250)), u'20090518011630000250') def test_build_schema(self): - (content_field_name, fields) = self.backend.build_schema(self.site.all_searchfields()) + (content_field_name, fields) = self.backend.build_schema(connections['default'].get_unified_index().all_searchfields()) self.assertEqual(content_field_name, 'text') self.assertEqual(len(fields), 13) self.assertEqual(fields, [ @@ -437,6 +417,9 @@ class LiveXapianMockSearchIndex(indexes.SearchIndex): pub_date = indexes.DateField(model_attr='pub_date') created = indexes.DateField() title = indexes.CharField() + + def get_model(self): + return MockModel class LiveXapianSearchQueryTestCase(TestCase): @@ -448,13 +431,19 @@ class LiveXapianSearchQueryTestCase(TestCase): def setUp(self): super(LiveXapianSearchQueryTestCase, self).setUp() - site = SearchSite() - backend = SearchBackend(site=site) - index = LiveXapianMockSearchIndex(MockModel, backend=backend) - site.register(MockModel, LiveXapianMockSearchIndex) + self.old_ui = connections['default'].get_unified_index() + ui = UnifiedIndex() + index = LiveXapianMockSearchIndex() + ui.build(indexes=[index]) + backend = connections['default'].get_backend() + connections['default']._index = ui backend.update(index, MockModel.objects.all()) - self.sq = SearchQuery(backend=backend) + self.sq = connections['default'].get_query() + + def tearDown(self): + connections['default']._index = self.old_ui + super(LiveXapianSearchQueryTestCase, self).tearDown() def test_get_spelling(self): self.sq.add_filter(SQ(content='indxd')) @@ -491,32 +480,32 @@ class LiveXapianSearchQueryTestCase(TestCase): self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND VALUE_RANGE 2 00010101000000 20090210015900 AND ( AND_NOT VALUE_RANGE 3 a david) AND ( AND_NOT VALUE_RANGE 4 20090212121300 99990101000000) AND VALUE_RANGE 1 b zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz AND (Q1 OR Q2 OR Q3)))') def test_log_query(self): - backends.reset_search_queries() - self.assertEqual(len(backends.queries), 0) + reset_search_queries() + self.assertEqual(len(connections['default'].queries), 0) # Stow. old_debug = settings.DEBUG settings.DEBUG = False len(self.sq.get_results()) - self.assertEqual(len(backends.queries), 0) + self.assertEqual(len(connections['default'].queries), 0) settings.DEBUG = True # Redefine it to clear out the cached results. - self.sq = SearchQuery(backend=SearchBackend()) + self.sq = connections['default'].get_query() self.sq.add_filter(SQ(name='bar')) len(self.sq.get_results()) - self.assertEqual(len(backends.queries), 1) - self.assertEqual(str(backends.queries[0]['query_string']), u'Xapian::Query((ZXNAMEbar OR XNAMEbar))') + self.assertEqual(len(connections['default'].queries), 1) + self.assertEqual(str(connections['default'].queries[0]['query_string']), u'Xapian::Query((ZXNAMEbar OR XNAMEbar))') # And again, for good measure. - self.sq = SearchQuery(backend=SearchBackend()) + self.sq = connections['default'].get_query() self.sq.add_filter(SQ(name='bar')) self.sq.add_filter(SQ(text='moof')) len(self.sq.get_results()) - self.assertEqual(len(backends.queries), 2) - self.assertEqual(str(backends.queries[0]['query_string']), u'Xapian::Query((ZXNAMEbar OR XNAMEbar))') - self.assertEqual(str(backends.queries[1]['query_string']), u'Xapian::Query(((ZXNAMEbar OR XNAMEbar) AND (ZXTEXTmoof OR XTEXTmoof)))') + self.assertEqual(len(connections['default'].queries), 2) + self.assertEqual(str(connections['default'].queries[0]['query_string']), u'Xapian::Query((ZXNAMEbar OR XNAMEbar))') + self.assertEqual(str(connections['default'].queries[1]['query_string']), u'Xapian::Query(((ZXNAMEbar OR XNAMEbar) AND (ZXTEXTmoof OR XTEXTmoof)))') # Restore. settings.DEBUG = old_debug @@ -531,14 +520,20 @@ class LiveXapianSearchQuerySetTestCase(TestCase): def setUp(self): super(LiveXapianSearchQuerySetTestCase, self).setUp() - site = SearchSite() - backend = SearchBackend(site=site) - index = LiveXapianMockSearchIndex(MockModel, backend=backend) - site.register(MockModel, LiveXapianMockSearchIndex) - backend.update(index, MockModel.objects.all()) + self.old_ui = connections['default'].get_unified_index() + self.ui = UnifiedIndex() + self.index = LiveXapianMockSearchIndex() + self.ui.build(indexes=[self.index]) + self.backend = connections['default'].get_backend() + connections['default']._index = self.ui + self.backend.update(self.index, MockModel.objects.all()) - self.sq = SearchQuery(backend=backend) - self.sqs = SearchQuerySet(query=self.sq) + self.sq = connections['default'].get_query() + self.sqs = SearchQuerySet() + + def tearDown(self): + connections['default']._index = self.old_ui + super(LiveXapianSearchQuerySetTestCase, self).tearDown() def test_result_class(self): # Assert that we're defaulting to ``SearchResult``. @@ -557,16 +552,14 @@ class LiveXapianSearchQuerySetTestCase(TestCase): class XapianBoostBackendTestCase(TestCase): def setUp(self): super(XapianBoostBackendTestCase, self).setUp() - - self.site = SearchSite() - self.sb = SearchBackend(site=self.site) - self.smmi = XapianBoostMockSearchIndex(AFourthMockModel, backend=self.sb) - self.site.register(AFourthMockModel, XapianBoostMockSearchIndex) - + # Stow. - import haystack - self.old_site = haystack.site - haystack.site = self.site + self.old_ui = connections['default'].get_unified_index() + self.ui = UnifiedIndex() + self.index = XapianBoostMockSearchIndex() + self.ui.build(indexes=[self.index]) + self.sb = connections['default'].get_backend() + connections['default']._index = self.ui self.sample_objs = [] @@ -583,12 +576,11 @@ class XapianBoostBackendTestCase(TestCase): self.sample_objs.append(mock) def tearDown(self): - import haystack - haystack.site = self.old_site + connections['default']._index = self.old_ui super(XapianBoostBackendTestCase, self).tearDown() def test_boost(self): - self.sb.update(self.smmi, self.sample_objs) + self.sb.update(self.index, self.sample_objs) sqs = SearchQuerySet() diff --git a/tests/xapian_tests/tests/xapian_query.py b/tests/xapian_tests/tests/xapian_query.py index 1c9eb51..503c52d 100644 --- a/tests/xapian_tests/tests/xapian_query.py +++ b/tests/xapian_tests/tests/xapian_query.py @@ -7,7 +7,7 @@ import shutil from django.conf import settings from django.test import TestCase -from haystack.backends.xapian_backend import SearchBackend, SearchQuery +from haystack import connections from haystack.query import SQ from core.models import MockModel, AnotherMockModel @@ -16,11 +16,11 @@ from core.models import MockModel, AnotherMockModel class XapianSearchQueryTestCase(TestCase): def setUp(self): super(XapianSearchQueryTestCase, self).setUp() - self.sq = SearchQuery(backend=SearchBackend()) + self.sq = connections['default'].get_query() def tearDown(self): - if os.path.exists(settings.HAYSTACK_XAPIAN_PATH): - shutil.rmtree(settings.HAYSTACK_XAPIAN_PATH) + if os.path.exists(settings.HAYSTACK_CONNECTIONS['default']['PATH']): + shutil.rmtree(settings.HAYSTACK_CONNECTIONS['default']['PATH']) super(XapianSearchQueryTestCase, self).tearDown() diff --git a/xapian_backend.py b/xapian_backend.py index 67b45ba..1cdfe00 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -1,7 +1,7 @@ # Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. __author__ = 'David Sauve' -__version__ = (1, 1, 5, 'beta') +__version__ = (2, 0, 0, 'beta') import time import datetime @@ -12,11 +12,11 @@ import shutil import sys import warnings -from django.conf import settings from django.core.exceptions import ImproperlyConfigured -from django.utils.encoding import smart_unicode, force_unicode +from django.utils.encoding import force_unicode -from haystack.backends import BaseSearchBackend, BaseSearchQuery, SearchNode, log_query +from haystack import connections +from haystack.backends import BaseEngine, BaseSearchBackend, BaseSearchQuery, SearchNode, log_query from haystack.exceptions import HaystackError, MissingDependency, MoreLikeThisError from haystack.fields import DateField, DateTimeField, IntegerField, FloatField, BooleanField, MultiValueField from haystack.models import SearchResult @@ -32,8 +32,6 @@ DOCUMENT_ID_TERM_PREFIX = 'Q' DOCUMENT_CUSTOM_TERM_PREFIX = 'X' DOCUMENT_CT_TERM_PREFIX = DOCUMENT_CUSTOM_TERM_PREFIX + 'CONTENTTYPE' -BACKEND_NAME = 'xapian' - DEFAULT_XAPIAN_FLAGS = ( xapian.QueryParser.FLAG_PHRASE | xapian.QueryParser.FLAG_BOOLEAN | @@ -50,7 +48,8 @@ class InvalidIndexError(HaystackError): class XHValueRangeProcessor(xapian.ValueRangeProcessor): def __init__(self, backend): - self.backend = backend or SearchBackend() + # FIXME: This needs to get smarter about pulling the right backend. + self.backend = backend or XapianSearchBackend() xapian.ValueRangeProcessor.__init__(self) def __call__(self, begin, end): @@ -107,7 +106,7 @@ class XHExpandDecider(xapian.ExpandDecider): return True -class SearchBackend(BaseSearchBackend): +class XapianSearchBackend(BaseSearchBackend): """ `SearchBackend` defines the Xapian search backend for use with the Haystack API for Django search. @@ -120,28 +119,33 @@ class SearchBackend(BaseSearchBackend): `WSGIApplicationGroup to %{GLOBAL}` when using mod_wsgi, or `PythonInterpreter main_interpreter` when using mod_python. - In order to use this backend, `HAYSTACK_XAPIAN_PATH` must be set in - your settings. This should point to a location where you would your + In order to use this backend, `PATH` must be included in the + `connection_options`. This should point to a location where you would your indexes to reside. """ - def __init__(self, site=None, language='english'): + def __init__(self, connection_alias, language='english', **connection_options): """ Instantiates an instance of `SearchBackend`. Optional arguments: - `site` -- The site to associate the backend with (default = None) - `stemming_language` -- The stemming language (default = 'english') + `connection_alias` -- The name of the connection + `language` -- The stemming language (default = 'english') + `**connection_options` -- The various options needed to setup + the backend. - Also sets the stemming language to be used to `stemming_language`. + Also sets the stemming language to be used to `language`. """ - super(SearchBackend, self).__init__(site) + super(XapianSearchBackend, self).__init__(connection_alias, **connection_options) - if not hasattr(settings, 'HAYSTACK_XAPIAN_PATH'): - raise ImproperlyConfigured('You must specify a HAYSTACK_XAPIAN_PATH in your settings.') + if not 'PATH' in connection_options: + raise ImproperlyConfigured("You must specify a 'PATH' in your settings for connection '%s'." % connection_alias) - if not os.path.exists(settings.HAYSTACK_XAPIAN_PATH): - os.makedirs(settings.HAYSTACK_XAPIAN_PATH) + self.path = connection_options.get('PATH') + if not os.path.exists(self.path): + os.makedirs(self.path) + + self.flags = connection_options.get('FLAGS', DEFAULT_XAPIAN_FLAGS) self.language = language self._schema = None self._content_field_name = None @@ -149,13 +153,13 @@ class SearchBackend(BaseSearchBackend): @property def schema(self): if not self._schema: - self._content_field_name, self._schema = self.build_schema(self.site.all_searchfields()) + self._content_field_name, self._schema = self.build_schema(connections[self.connection_alias].get_unified_index().all_searchfields()) return self._schema @property def content_field_name(self): if not self._content_field_name: - self._content_field_name, self._schema = self.build_schema(self.site.all_searchfields()) + self._content_field_name, self._schema = self.build_schema(connections[self.connection_alias].get_unified_index().all_searchfields()) return self._content_field_name def update(self, index, iterable): @@ -204,7 +208,7 @@ class SearchBackend(BaseSearchBackend): term_generator = xapian.TermGenerator() term_generator.set_database(database) term_generator.set_stemmer(xapian.Stem(self.language)) - if getattr(settings, 'HAYSTACK_INCLUDE_SPELLING', False) is True: + if self.include_spelling is True: term_generator.set_flags(xapian.TermGenerator.FLAG_SPELLING) term_generator.set_document(document) @@ -296,10 +300,10 @@ class SearchBackend(BaseSearchBackend): database = self._database(writable=True) if not models: # Because there does not appear to be a "clear all" method, - # it's much quicker to remove the contents of the `HAYSTACK_XAPIAN_PATH` + # it's much quicker to remove the contents of the `self.path` # folder than it is to remove each document one at a time. - if os.path.exists(settings.HAYSTACK_XAPIAN_PATH): - shutil.rmtree(settings.HAYSTACK_XAPIAN_PATH) + if os.path.exists(self.path): + shutil.rmtree(self.path) else: for model in models: database.delete_document( @@ -349,16 +353,11 @@ class SearchBackend(BaseSearchBackend): If `query` is None, returns no results. - If `HAYSTACK_INCLUDE_SPELLING` was enabled in `settings.py`, the + If `INCLUDE_SPELLING` was enabled in the connection options, the extra flag `FLAG_SPELLING_CORRECTION` will be passed to the query parser and any suggestions for spell correction will be returned as well as the results. """ - if not self.site: - from haystack import site - else: - site = self.site - if xapian.Query.empty(query): return { 'results': [], @@ -370,7 +369,7 @@ class SearchBackend(BaseSearchBackend): if result_class is None: result_class = SearchResult - if getattr(settings, 'HAYSTACK_INCLUDE_SPELLING', False) is True: + if self.include_spelling is True: spelling_suggestion = self._do_spelling_suggestion(database, query, spelling_query) else: spelling_suggestion = '' @@ -383,7 +382,7 @@ class SearchBackend(BaseSearchBackend): ) if limit_to_registered_models: - registered_models = self.build_registered_models_list() + registered_models = self.build_models_list() if len(registered_models) > 0: query = xapian.Query( @@ -432,7 +431,7 @@ class SearchBackend(BaseSearchBackend): ) } results.append( - result_class(app_label, module_name, pk, match.percent, searchsite=site, **model_data) + result_class(app_label, module_name, pk, match.percent, **model_data) ) if facets: @@ -481,11 +480,6 @@ class SearchBackend(BaseSearchBackend): Finally, processes the resulting matches and returns. """ - if not self.site: - from haystack import site - else: - site = self.site - database = self._database() if result_class is None: @@ -513,7 +507,7 @@ class SearchBackend(BaseSearchBackend): xapian.Query.OP_AND_NOT, [query, DOCUMENT_ID_TERM_PREFIX + get_identifier(model_instance)] ) if limit_to_registered_models: - registered_models = self.build_registered_models_list() + registered_models = self.build_models_list() if len(registered_models) > 0: query = xapian.Query( @@ -537,7 +531,7 @@ class SearchBackend(BaseSearchBackend): for match in matches: app_label, module_name, pk, model_data = pickle.loads(self._get_document_data(database, match.document)) results.append( - result_class(app_label, module_name, pk, match.percent, searchsite=site, **model_data) + result_class(app_label, module_name, pk, match.percent, **model_data) ) return { @@ -565,7 +559,6 @@ class SearchBackend(BaseSearchBackend): elif query_string == '': return xapian.Query() # Match nothing - flags = getattr(settings, 'HAYSTACK_XAPIAN_FLAGS', DEFAULT_XAPIAN_FLAGS) qp = xapian.QueryParser() qp.set_database(self._database()) qp.set_stemmer(xapian.Stem(self.language)) @@ -581,7 +574,7 @@ class SearchBackend(BaseSearchBackend): vrp = XHValueRangeProcessor(self) qp.add_valuerangeprocessor(vrp) - return qp.parse_query(query_string, flags) + return qp.parse_query(query_string, self.flags) def build_schema(self, fields): """ @@ -811,12 +804,12 @@ class SearchBackend(BaseSearchBackend): Returns an instance of a xapian.Database or xapian.WritableDatabase """ if writable: - database = xapian.WritableDatabase(settings.HAYSTACK_XAPIAN_PATH, xapian.DB_CREATE_OR_OPEN) + database = xapian.WritableDatabase(self.path, xapian.DB_CREATE_OR_OPEN) else: try: - database = xapian.Database(settings.HAYSTACK_XAPIAN_PATH) + database = xapian.Database(self.path) except xapian.DatabaseOpeningError: - raise InvalidIndexError(u'Unable to open index at %s' % settings.HAYSTACK_XAPIAN_PATH) + raise InvalidIndexError(u'Unable to open index at %s' % self.path) return database @@ -900,24 +893,12 @@ class SearchBackend(BaseSearchBackend): return False -class SearchQuery(BaseSearchQuery): +class XapianSearchQuery(BaseSearchQuery): """ This class is the Xapian specific version of the SearchQuery class. It acts as an intermediary between the ``SearchQuerySet`` and the ``SearchBackend`` itself. """ - def __init__(self, backend=None, site=None): - """ - Create a new instance of the SearchQuery setting the backend as - specified. If no backend is set, will use the Xapian `SearchBackend`. - - Optional arguments: - ``backend`` -- The ``SearchBackend`` to use (default = None) - ``site`` -- The site to use (default = None) - """ - super(SearchQuery, self).__init__(backend=backend) - self.backend = backend or SearchBackend(site=site) - def build_query(self): if not self.query_filter: query = xapian.Query('') @@ -1305,3 +1286,8 @@ def run_mlt(self): results = self.backend.more_like_this(self._mlt_instance, additional_query_string, **kwargs) self._results = results.get('results', []) self._hit_count = results.get('hits', 0) + + +class XapianEngine(BaseEngine): + backend = XapianSearchBackend + query = XapianSearchQuery From 23ca1ed97a5ad9e00cfc8e4a9b1912ca0b3c6896 Mon Sep 17 00:00:00 2001 From: David Sauve Date: Thu, 14 Jul 2011 16:12:59 -0700 Subject: [PATCH 02/14] Updated copyright notice. --- README.rst | 4 ++-- tests/xapian_settings.py | 3 ++- tests/xapian_tests/__init__.py | 3 ++- tests/xapian_tests/models.py | 3 ++- tests/xapian_tests/tests/__init__.py | 3 ++- tests/xapian_tests/tests/xapian_backend.py | 4 +++- tests/xapian_tests/tests/xapian_query.py | 3 ++- xapian_backend.py | 3 ++- 8 files changed, 17 insertions(+), 9 deletions(-) diff --git a/README.rst b/README.rst index 858713c..6310ba3 100644 --- a/README.rst +++ b/README.rst @@ -91,12 +91,12 @@ The latest source code can always be found here: `github.com/notanumber/xapian-h Credits ------- -xapian-haystack is maintained by `David Sauve `_, and was originally funded by `Trapeze `_. +xapian-haystack is maintained by `David Sauve `_, and was originally funded by `Trapeze `_. License ------- -xapian-haystack is Copyright (c) 2009-2011 David Sauve, Trapeze. It is free software, and may be redistributed under the terms specified in the LICENSE file. +xapian-haystack is Copyright (c) 2009, 2010, 2011 David Sauve, 2009, 2010 Trapeze. It is free software, and may be redistributed under the terms specified in the LICENSE file. Questions, Comments, Concerns: ------------------------------ diff --git a/tests/xapian_settings.py b/tests/xapian_settings.py index 203056d..262136c 100755 --- a/tests/xapian_settings.py +++ b/tests/xapian_settings.py @@ -1,4 +1,5 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze import os from settings import * diff --git a/tests/xapian_tests/__init__.py b/tests/xapian_tests/__init__.py index 91e7482..d0dcb66 100644 --- a/tests/xapian_tests/__init__.py +++ b/tests/xapian_tests/__init__.py @@ -1 +1,2 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. \ No newline at end of file +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze diff --git a/tests/xapian_tests/models.py b/tests/xapian_tests/models.py index 91e7482..d0dcb66 100644 --- a/tests/xapian_tests/models.py +++ b/tests/xapian_tests/models.py @@ -1 +1,2 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. \ No newline at end of file +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze diff --git a/tests/xapian_tests/tests/__init__.py b/tests/xapian_tests/tests/__init__.py index 5eaa148..13030c7 100644 --- a/tests/xapian_tests/tests/__init__.py +++ b/tests/xapian_tests/tests/__init__.py @@ -1,4 +1,5 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze import warnings diff --git a/tests/xapian_tests/tests/xapian_backend.py b/tests/xapian_tests/tests/xapian_backend.py index 378a9d4..eedc045 100644 --- a/tests/xapian_tests/tests/xapian_backend.py +++ b/tests/xapian_tests/tests/xapian_backend.py @@ -1,4 +1,6 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze + # Based on original code by Daniel Lindsley as part of the Haystack test suite. import cPickle as pickle diff --git a/tests/xapian_tests/tests/xapian_query.py b/tests/xapian_tests/tests/xapian_query.py index 6f7c206..cf92d5a 100644 --- a/tests/xapian_tests/tests/xapian_query.py +++ b/tests/xapian_tests/tests/xapian_query.py @@ -1,4 +1,5 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze import datetime import os diff --git a/xapian_backend.py b/xapian_backend.py index d35f146..b819b6d 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -1,4 +1,5 @@ -# Copyright (C) 2009-2011 David Sauve, Trapeze. All rights reserved. +# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010 Trapeze __author__ = 'David Sauve' __version__ = (2, 0, 0, 'beta') From 55ee1c4ad185cf7bc1fff282bfd00bb3613bb78f Mon Sep 17 00:00:00 2001 From: David Sauve Date: Thu, 14 Jul 2011 15:52:03 -0700 Subject: [PATCH 03/14] Switched license back to GPL v2. --- LICENSE | 825 +++++++++++++++++--------------------------------------- 1 file changed, 242 insertions(+), 583 deletions(-) diff --git a/LICENSE b/LICENSE index 94a0453..d8cf7d4 100644 --- a/LICENSE +++ b/LICENSE @@ -1,621 +1,280 @@ GNU GENERAL PUBLIC LICENSE - Version 3, 29 June 2007 + Version 2, June 1991 - Copyright (C) 2007 Free Software Foundation, Inc. + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. Preamble - The GNU General Public License is a free, copyleft license for -software and other kinds of works. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -the GNU General Public License is intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. We, the Free Software Foundation, use the -GNU General Public License for most of our software; it applies also to -any other work released this way by its authors. You can apply it to + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to your programs, too. When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. - To protect your rights, we need to prevent others from denying you -these rights or asking you to surrender the rights. Therefore, you have -certain responsibilities if you distribute copies of the software, or if -you modify it: responsibilities to respect the freedom of others. + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. For example, if you distribute copies of such a program, whether -gratis or for a fee, you must pass on to the recipients the same -freedoms that you received. You must make sure that they, too, receive -or can get the source code. And you must show them these terms so they -know their rights. +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. - Developers that use the GNU GPL protect your rights with two steps: -(1) assert copyright on the software, and (2) offer you this License -giving you legal permission to copy, distribute and/or modify it. + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. - For the developers' and authors' protection, the GPL clearly explains -that there is no warranty for this free software. For both users' and -authors' sake, the GPL requires that modified versions be marked as -changed, so that their problems will not be attributed erroneously to -authors of previous versions. + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. - Some devices are designed to deny users access to install or run -modified versions of the software inside them, although the manufacturer -can do so. This is fundamentally incompatible with the aim of -protecting users' freedom to change the software. The systematic -pattern of such abuse occurs in the area of products for individuals to -use, which is precisely where it is most unacceptable. Therefore, we -have designed this version of the GPL to prohibit the practice for those -products. If such problems arise substantially in other domains, we -stand ready to extend this provision to those domains in future versions -of the GPL, as needed to protect the freedom of users. - - Finally, every program is threatened constantly by software patents. -States should not allow patents to restrict development and use of -software on general-purpose computers, but in those that do, we wish to -avoid the special danger that patents applied to a free program could -make it effectively proprietary. To prevent this, the GPL assures that -patents cannot be used to render the program non-free. + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. The precise terms and conditions for copying, distribution and modification follow. - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to this License. - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. - 13. Use with the GNU Affero General Public License. +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU Affero General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the special requirements of the GNU Affero General Public License, -section 13, concerning interaction through a network will apply to the -combination as such. +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. - 14. Revised Versions of this License. +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. - The Free Software Foundation may publish revised and/or new versions of -the GNU General Public License from time to time. Such new versions will + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU General Public License, you may choose any version ever published -by the Free Software Foundation. +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. - If the Program specifies that a proxy can decide which future -versions of the GNU General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. + NO WARRANTY - 15. Disclaimer of Warranty. + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. END OF TERMS AND CONDITIONS From dbf8eb65d3170013e06dc24401e2a02de9ba9d1b Mon Sep 17 00:00:00 2001 From: David Sauve Date: Mon, 8 Aug 2011 14:53:32 -0700 Subject: [PATCH 04/14] Ported build_params method form master and 1.0.X branches. --- xapian_backend.py | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/xapian_backend.py b/xapian_backend.py index b819b6d..d495715 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -902,6 +902,14 @@ class XapianSearchQuery(BaseSearchQuery): It acts as an intermediary between the ``SearchQuerySet`` and the ``SearchBackend`` itself. """ + def build_params(self, *args, **kwargs): + kwargs = super(BaseSearchQuery, self).build_params(*args, **kwargs) + + if self.end_offset is not None: + kwargs['end_offset'] = self.end_offset - self.start_offset + + return kwargs + def build_query(self): if not self.query_filter: query = xapian.Query('') @@ -1234,6 +1242,7 @@ def _marshal_datetime(dt): dt.year, dt.month, dt.day, dt.hour, dt.minute, dt.second ) +<<<<<<< HEAD def run(self): @@ -1296,3 +1305,5 @@ def run_mlt(self): class XapianEngine(BaseEngine): backend = XapianSearchBackend query = XapianSearchQuery +======= +>>>>>>> a845377... Removed leftover run and run_mlt methods. Replaced with overriden build_params. This should fix gh-85 and gh-82. From 2109b8913d3119fdcaa1bdac6bf83f59eaaeed66 Mon Sep 17 00:00:00 2001 From: David Sauve Date: Mon, 8 Aug 2011 20:08:36 -0700 Subject: [PATCH 05/14] Fixed leftover bits from pervious merge --- xapian_backend.py | 60 ----------------------------------------------- 1 file changed, 60 deletions(-) diff --git a/xapian_backend.py b/xapian_backend.py index d495715..ec6cf7d 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -1242,68 +1242,8 @@ def _marshal_datetime(dt): dt.year, dt.month, dt.day, dt.hour, dt.minute, dt.second ) -<<<<<<< HEAD - - -def run(self): - """ - Builds and executes the query. Returns a list of search results. - """ - final_query = self.build_query() - kwargs = { - 'start_offset': self.start_offset, - } - - if self.order_by: - kwargs['sort_by'] = self.order_by - - if self.end_offset is not None: - kwargs['end_offset'] = self.end_offset - self.start_offset - - if self.highlight: - kwargs['highlight'] = self.highlight - - if self.facets: - kwargs['facets'] = list(self.facets) - - if self.date_facets: - kwargs['date_facets'] = self.date_facets - - if self.query_facets: - kwargs['query_facets'] = self.query_facets - - if self.narrow_queries: - kwargs['narrow_queries'] = self.narrow_queries - - results = self.backend.search(final_query, **kwargs) - self._results = results.get('results', []) - self._hit_count = results.get('hits', 0) - self._facet_counts = results.get('facets', {}) - self._spelling_suggestion = results.get('spelling_suggestion', None) - - -def run_mlt(self): - """ - Builds and executes the query. Returns a list of search results. - """ - if self._more_like_this is False or self._mlt_instance is None: - raise MoreLikeThisError("No instance was provided to determine 'More Like This' results.") - - additional_query_string = self.build_query() - kwargs = { - 'start_offset': self.start_offset, - } - - if self.end_offset is not None: - kwargs['end_offset'] = self.end_offset - self.start_offset - - results = self.backend.more_like_this(self._mlt_instance, additional_query_string, **kwargs) - self._results = results.get('results', []) - self._hit_count = results.get('hits', 0) class XapianEngine(BaseEngine): backend = XapianSearchBackend query = XapianSearchQuery -======= ->>>>>>> a845377... Removed leftover run and run_mlt methods. Replaced with overriden build_params. This should fix gh-85 and gh-82. From bca561c29d0acbe5dccd7df757451a45dd08f51c Mon Sep 17 00:00:00 2001 From: David Sauve Date: Mon, 8 Aug 2011 19:54:58 -0700 Subject: [PATCH 06/14] Merged build_schema fix from master --- tests/xapian_tests/tests/xapian_backend.py | 51 +++++++++++----------- xapian_backend.py | 9 ++-- 2 files changed, 32 insertions(+), 28 deletions(-) diff --git a/tests/xapian_tests/tests/xapian_backend.py b/tests/xapian_tests/tests/xapian_backend.py index eedc045..119220f 100644 --- a/tests/xapian_tests/tests/xapian_backend.py +++ b/tests/xapian_tests/tests/xapian_backend.py @@ -388,22 +388,23 @@ class XapianSearchBackendTestCase(TestCase): def test_build_schema(self): (content_field_name, fields) = self.backend.build_schema(connections['default'].get_unified_index().all_searchfields()) self.assertEqual(content_field_name, 'text') - self.assertEqual(len(fields), 14) + self.assertEqual(len(fields), 15) self.assertEqual(fields, [ - {'column': 0, 'type': 'text', 'field_name': 'name', 'multi_valued': 'false'}, - {'column': 1, 'type': 'text', 'field_name': 'tags', 'multi_valued': 'true'}, - {'column': 2, 'type': 'text', 'field_name': 'keys', 'multi_valued': 'true'}, - {'column': 3, 'type': 'text', 'field_name': 'text', 'multi_valued': 'false'}, - {'column': 4, 'type': 'float', 'field_name': 'popularity', 'multi_valued': 'false'}, - {'column': 5, 'type': 'text', 'field_name': 'sites', 'multi_valued': 'true'}, - {'column': 6, 'type': 'long', 'field_name': 'value', 'multi_valued': 'false'}, - {'column': 7, 'type': 'text', 'field_name': 'url', 'multi_valued': 'false'}, - {'column': 8, 'type': 'boolean', 'field_name': 'flag', 'multi_valued': 'false'}, - {'column': 9, 'type': 'text', 'field_name': 'titles', 'multi_valued': 'true'}, - {'column': 10, 'type': 'date', 'field_name': 'exp_date', 'multi_valued': 'false'}, - {'column': 11, 'type': 'text', 'field_name': 'name_exact', 'multi_valued': 'false'}, - {'column': 12, 'type': 'date', 'field_name': 'pub_date', 'multi_valued': 'false'}, - {'column': 13, 'type': 'text', 'field_name': 'empty', 'multi_valued': 'false'} + {'column': 0, 'type': 'text', 'field_name': 'id', 'multi_valued': 'false'}, + {'column': 1, 'type': 'text', 'field_name': 'empty', 'multi_valued': 'false'}, + {'column': 2, 'type': 'date', 'field_name': 'exp_date', 'multi_valued': 'false'}, + {'column': 3, 'type': 'boolean', 'field_name': 'flag', 'multi_valued': 'false'}, + {'column': 4, 'type': 'text', 'field_name': 'keys', 'multi_valued': 'true'}, + {'column': 5, 'type': 'text', 'field_name': 'name', 'multi_valued': 'false'}, + {'column': 6, 'type': 'text', 'field_name': 'name_exact', 'multi_valued': 'false'}, + {'column': 7, 'type': 'float', 'field_name': 'popularity', 'multi_valued': 'false'}, + {'column': 8, 'type': 'date', 'field_name': 'pub_date', 'multi_valued': 'false'}, + {'column': 9, 'type': 'text', 'field_name': 'sites', 'multi_valued': 'true'}, + {'column': 10, 'type': 'text', 'field_name': 'tags', 'multi_valued': 'true'}, + {'column': 11, 'type': 'text', 'field_name': 'text', 'multi_valued': 'false'}, + {'column': 12, 'type': 'text', 'field_name': 'titles', 'multi_valued': 'true'}, + {'column': 13, 'type': 'text', 'field_name': 'url', 'multi_valued': 'false'}, + {'column': 14, 'type': 'long', 'field_name': 'value', 'multi_valued': 'false'} ]) def test_parse_query(self): @@ -416,11 +417,11 @@ class XapianSearchBackendTestCase(TestCase): else: self.assertEqual(str(self.backend.parse_query('name:da*')), 'Xapian::Query((XNAMEdavid1:(pos=1) OR XNAMEdavid2:(pos=1) OR XNAMEdavid3:(pos=1)))') - self.assertEqual(str(self.backend.parse_query('name:david1..david2')), 'Xapian::Query(VALUE_RANGE 0 david1 david2)') - self.assertEqual(str(self.backend.parse_query('value:0..10')), 'Xapian::Query(VALUE_RANGE 6 000000000000 000000000010)') - self.assertEqual(str(self.backend.parse_query('value:..10')), 'Xapian::Query(VALUE_RANGE 6 %012d 000000000010)' % (-sys.maxint - 1)) - self.assertEqual(str(self.backend.parse_query('value:10..*')), 'Xapian::Query(VALUE_RANGE 6 000000000010 %012d)' % sys.maxint) - self.assertEqual(str(self.backend.parse_query('popularity:25.5..100.0')), 'Xapian::Query(VALUE_RANGE 4 \xb2` \xba@)') + self.assertEqual(str(self.backend.parse_query('name:david1..david2')), 'Xapian::Query(VALUE_RANGE 5 david1 david2)') + self.assertEqual(str(self.backend.parse_query('value:0..10')), 'Xapian::Query(VALUE_RANGE 14 000000000000 000000000010)') + self.assertEqual(str(self.backend.parse_query('value:..10')), 'Xapian::Query(VALUE_RANGE 14 %012d 000000000010)' % (-sys.maxint - 1)) + self.assertEqual(str(self.backend.parse_query('value:10..*')), 'Xapian::Query(VALUE_RANGE 14 000000000010 %012d)' % sys.maxint) + self.assertEqual(str(self.backend.parse_query('popularity:25.5..100.0')), 'Xapian::Query(VALUE_RANGE 7 \xb2` \xba@)') class LiveXapianMockSearchIndex(indexes.SearchIndex): @@ -468,19 +469,19 @@ class LiveXapianSearchQueryTestCase(TestCase): def test_build_query_gt(self): self.sq.add_filter(SQ(name__gt='m')) - self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT VALUE_RANGE 3 a m))') + self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT VALUE_RANGE 2 a m))') def test_build_query_gte(self): self.sq.add_filter(SQ(name__gte='m')) - self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(VALUE_RANGE 3 m zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz)') + self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(VALUE_RANGE 2 m zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz)') def test_build_query_lt(self): self.sq.add_filter(SQ(name__lt='m')) - self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT VALUE_RANGE 3 m zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz))') + self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT VALUE_RANGE 2 m zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz))') def test_build_query_lte(self): self.sq.add_filter(SQ(name__lte='m')) - self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(VALUE_RANGE 3 a m)') + self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(VALUE_RANGE 2 a m)') def test_build_query_multiple_filter_types(self): self.sq.add_filter(SQ(content='why')) @@ -489,7 +490,7 @@ class LiveXapianSearchQueryTestCase(TestCase): self.sq.add_filter(SQ(created__lt=datetime.datetime(2009, 2, 12, 12, 13, 0))) self.sq.add_filter(SQ(title__gte='B')) self.sq.add_filter(SQ(id__in=[1, 2, 3])) - self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND VALUE_RANGE 2 00010101000000 20090210015900 AND ( AND_NOT VALUE_RANGE 3 a david) AND ( AND_NOT VALUE_RANGE 4 20090212121300 99990101000000) AND VALUE_RANGE 1 b zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz AND (Q1 OR Q2 OR Q3)))') + self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND VALUE_RANGE 3 00010101000000 20090210015900 AND ( AND_NOT VALUE_RANGE 2 a david) AND ( AND_NOT VALUE_RANGE 1 20090212121300 99990101000000) AND VALUE_RANGE 5 b zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz AND (Q1 OR Q2 OR Q3)))') def test_log_query(self): reset_search_queries() diff --git a/xapian_backend.py b/xapian_backend.py index ec6cf7d..2fc8055 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -18,6 +18,7 @@ from django.utils.encoding import force_unicode from haystack import connections from haystack.backends import BaseEngine, BaseSearchBackend, BaseSearchQuery, SearchNode, log_query +from haystack.constants import ID, DJANGO_CT, DJANGO_ID from haystack.exceptions import HaystackError, MissingDependency, MoreLikeThisError from haystack.fields import DateField, DateTimeField, IntegerField, FloatField, BooleanField, MultiValueField from haystack.models import SearchResult @@ -590,10 +591,12 @@ class XapianSearchBackend(BaseSearchBackend): an indexed meta-data. """ content_field_name = '' - schema_fields = [] - column = 0 + schema_fields = [ + {'field_name': ID, 'type': 'text', 'multi_valued': 'false', 'column': 0}, + ] + column = len(schema_fields) - for field_name, field_class in fields.items(): + for field_name, field_class in sorted(fields.items(), key=lambda n: n[0]): if field_class.document is True: content_field_name = field_class.index_fieldname From 4a17679c0a1b86d6afae3dddf413bfefa5836682 Mon Sep 17 00:00:00 2001 From: David Sauve Date: Mon, 8 Aug 2011 20:14:23 -0700 Subject: [PATCH 07/14] Added James Addison to AUTHORS --- AUTHORS | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/AUTHORS b/AUTHORS index 75481f0..86c2256 100644 --- a/AUTHORS +++ b/AUTHORS @@ -23,4 +23,5 @@ Thanks to: * Sym Roe for a patch that improved performance in "more-like-this" and suggestion the removal of FLAG_PARTIAL. * liranz for pointing out a potential conflict with arguments pass into `SearchResult` * Jacob Kaplan-Moss for pointing out that write permission shouldn't be required for searching. - * glassresistor for assistance troubleshooting an issue with boosting a phrase query & a patch to make weighting schemes overridable. \ No newline at end of file + * glassresistor for assistance troubleshooting an issue with boosting a phrase query & a patch to make weighting schemes overridable. + * James Addison for helping to debug an intermittent issue with `order_by` and `build_schema`. \ No newline at end of file From 5754a321061b57f9562ead5b0f17a9c2ff453e66 Mon Sep 17 00:00:00 2001 From: David Sauve Date: Mon, 8 Aug 2011 20:15:04 -0700 Subject: [PATCH 08/14] Removed RELEASE. Is out of date. See Github for changes. --- RELEASES | 147 ------------------------------------------------------- 1 file changed, 147 deletions(-) delete mode 100644 RELEASES diff --git a/RELEASES b/RELEASES deleted file mode 100644 index ab08126..0000000 --- a/RELEASES +++ /dev/null @@ -1,147 +0,0 @@ -xapian-haystack-1.1.5BETA -========================= - -Tagged on December 20, 2010 by David Sauve - -Code Changes ------------- -* Merged `field_weights` branch to add support for field weights for Haystack 1.1 - -Known Issues ------------- -* `SearchBackend.search` with `highlight=True` converts terms to lowercase in result content. -* __in filter combined with punctuation drops valid results -* Spelling suggestions not programatically useful -* `more_like_this` slow on large database - -* * * - -xapian-haystack-1.1.4BETA -========================= - -Tagged on December 6, 2010 by David Sauve - -Code Changes ------------- -* Updated SearchBackend.update to be smarter when indexing multi-value fields and stemming. It will now only stem text fields and will properly index each field of a MultiValueField. -* MultiValueFields will no longer store data in the value column of the index. -* Faceted fields will now be automatically duplicated internally. This corresponds to Haystack, SHA c8f8d, http://github.com/toastdriven/django-haystack/commit/c8f8dcc2d79a9dcb67deefdc031629655b874820 -* `__startswith` filter has been improved to work more efficiently. -* `SearchResults` obey the type of data chosen in their corresponding field in the `SearchIndex` if present. -* Changed `SearchBackend.update` method to index terms with punctuation as well as using the Xapian.TermGenerator. -* Fixed another occurrence of DatabaseModifiedError -* Updated for compatibility with Xapian 1.2 by removing deprecated method calls and slightly refactoring the way queries are constructed. -* SearchQuery._term_query will now properly build a query for field `id` and `django_ct` fields. -* Rewrote `clear` to `shutil.rmtree` instead of iterating all of the database documents. -* Corrected result count. Now queries the match set for the correct count rather than using the estimated count. - -Known Issues ------------- -* `SearchBackend.search` with `highlight=True` converts terms to lowercase in result content. -* __in filter combined with punctuation drops valid results - -* * * - -xapian-haystack-1.1.3BETA -========================= - -Tagged on January 27, 2010 by David Sauve - -Minor Code Changes ------------------- -* Corrected an issue where `site` was not being passed into SearchBackend. -* Corrected an issue with SearchBackend.search that raised an OverFlowError when trying to slice a SearchQueryset. - -Known Issues ------------- -* `SearchBackend.search` with `highlight=True` converts terms to lowercase in result content. -* `SearchResults` should obey the type of data chosen in their corresponding field in the `SearchIndex` if present -* `__startswith` filter is highly inefficient, especially with large data-sets. -* MultiValueFields should not store data in the value column of the index -* SearchQuery doesn't handle multiple exclude attributes correctly - -* * * - -xapian-haystack-1.1.2BETA -========================= - -Tagged on January 15, 2010 by David Sauve - -Minor Code Changes ------------------- -* Corrected an issue with multiple-term boosts incorrectly weighting terms and returning unexpected results. -* Added early detection and recovery for DatabaseModifiedError. - -Known Issues ------------- -* `SearchBackend.search` with `highlight=True` converts terms to lowercase in result content. -* `SearchResults` should obey the type of data chosen in their corresponding field in the `SearchIndex` if present - -* * * - -xapian-haystack-1.1.1BETA -========================= - -Tagged on December 8, 2009 by David Sauve - -Major Code Changes ------------------- -* `SearchBackend` now has two additional properties, `schema` and `content_field`, that are cached after the first access. This fixes an issue where running a `SearchQuery` with value ranges sometimes caused an exception to be raised. - -Known Issues ------------- -* `SearchBackend.search` with `highlight=True` converts terms to lowercase in result content. - -* * * - -xapian-haystack-1.1.0BETA -========================= - -Tagged on December 6, 2009 by David Sauve - -Major Code Changes ------------------- -* `SearchBackend.search` now takes a Xapian::Query instead of a query_string. -* `SearchQuery.build_query` now returns a Xapian::Query -* `SearchBackend` now includes an extra `parse_query` method that takes a query string and returns a Xapian::Query - -Known Issues ------------- -* `SearchBackend.search` with `highlight=True` converts terms to lowercase in result content. - -* * * - -xapian-haystack-1.0.1BETA -========================= - -Tagged on September 11, 2009 by David Sauve - -* * * - -xapian-haystack-1.0.0BETA -========================= - -Tagged on August 11, 2009 by David Sauve - -* * * - -xapian-haystack-0.7.0ALPHA -========================== - -Tagged on August 2, 2009 by David Sauve - -* * * - -xapian-haystack-0.6.0ALPHA -========================== - -Tagged on July 31, 2009 by David Sauve - -* * * - -xapian-haystack-0.5.0ALPHA -========================== - -Tagged on July 27, 2009 by David Sauve - -* * * \ No newline at end of file From da66673433524198192787ab36e3edb61e06d60d Mon Sep 17 00:00:00 2001 From: David Sauve Date: Mon, 8 Aug 2011 20:17:19 -0700 Subject: [PATCH 09/14] Removed TODO --- TODO | 18 ------------------ 1 file changed, 18 deletions(-) delete mode 100644 TODO diff --git a/TODO b/TODO deleted file mode 100644 index 796dae9..0000000 --- a/TODO +++ /dev/null @@ -1,18 +0,0 @@ -Future -====== - -* Language stemming (needs to be implemented by Haystack first) - -Complete -======== - -* Spelling correction -* `narrow_queries` on SearchBackend.search -* Search ordering by field -* Multi field sorting -* `highlight` on SearchBackend.search -* SearchQuerySet.boost() -* Figure out how to deal with accents? (eg., resume vs résumé). -* `date_facets` on SearchBackend.search -* `query_facets` on SearchBackend.search -* Refactor SearchBackend and SearchQuery to make use of the Xapian.Query object natively instead of passing query strings between them. From b089df8af4f20bd5928670f992353dd3808701ea Mon Sep 17 00:00:00 2001 From: David Sauve Date: Sat, 27 Aug 2011 15:43:09 -0700 Subject: [PATCH 10/14] Fixed improperly backported call to `super` in XapianSearchQuery. Thanks Jezdez! --- xapian_backend.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xapian_backend.py b/xapian_backend.py index 2fc8055..78f1317 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -906,7 +906,7 @@ class XapianSearchQuery(BaseSearchQuery): ``SearchBackend`` itself. """ def build_params(self, *args, **kwargs): - kwargs = super(BaseSearchQuery, self).build_params(*args, **kwargs) + kwargs = super(XapianSearchQuery, self).build_params(*args, **kwargs) if self.end_offset is not None: kwargs['end_offset'] = self.end_offset - self.start_offset From d97c0f2a7866ded02415c60dc73dfd66d15cc957 Mon Sep 17 00:00:00 2001 From: David Sauve Date: Fri, 20 Apr 2012 11:44:16 -0700 Subject: [PATCH 11/14] Import settings from django.conf --- xapian_backend.py | 1 + 1 file changed, 1 insertion(+) diff --git a/xapian_backend.py b/xapian_backend.py index 78f1317..386170e 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -13,6 +13,7 @@ import shutil import sys import warnings +from django.conf import settings from django.core.exceptions import ImproperlyConfigured from django.utils.encoding import force_unicode From ec68cb0917411967948bfe9e1565b5d83c56c6ae Mon Sep 17 00:00:00 2001 From: David Sauve Date: Fri, 20 Apr 2012 11:44:32 -0700 Subject: [PATCH 12/14] Updated copyright notice --- xapian_backend.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/xapian_backend.py b/xapian_backend.py index 386170e..b77a287 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze __author__ = 'David Sauve' From f9e17b7a0110759f6a9dac992e002a75cbe523ab Mon Sep 17 00:00:00 2001 From: David Sauve Date: Fri, 20 Apr 2012 11:44:40 -0700 Subject: [PATCH 13/14] Fixed pylint errors --- tests/xapian_tests/tests/xapian_backend.py | 199 ++++++------ xapian_backend.py | 358 ++++++++++----------- 2 files changed, 276 insertions(+), 281 deletions(-) diff --git a/tests/xapian_tests/tests/xapian_backend.py b/tests/xapian_tests/tests/xapian_backend.py index 119220f..3acab67 100644 --- a/tests/xapian_tests/tests/xapian_backend.py +++ b/tests/xapian_tests/tests/xapian_backend.py @@ -3,7 +3,6 @@ # Based on original code by Daniel Lindsley as part of the Haystack test suite. -import cPickle as pickle import datetime import os import shutil @@ -17,7 +16,6 @@ from django.test import TestCase from haystack import connections, reset_search_queries from haystack import indexes from haystack.backends.xapian_backend import _marshal_value -from haystack.exceptions import HaystackError from haystack.models import SearchResult from haystack.query import SearchQuerySet, SQ from haystack.utils.loading import UnifiedIndex @@ -36,16 +34,16 @@ class XapianMockModel(models.Model): pub_date = models.DateTimeField(default=datetime.datetime.now) exp_date = models.DateTimeField(default=datetime.datetime.now) tag = models.ForeignKey(MockTag) - + value = models.IntegerField(default=0) flag = models.BooleanField(default=True) slug = models.SlugField() popularity = models.FloatField(default=0.0) url = models.URLField() - + def __unicode__(self): return self.author - + def hello(self): return 'World!' @@ -65,16 +63,16 @@ class XapianMockSearchIndex(indexes.SearchIndex): month = indexes.CharField(indexed=False) url = indexes.CharField(model_attr='url') empty = indexes.CharField() - + # Various MultiValueFields sites = indexes.MultiValueField() tags = indexes.MultiValueField() keys = indexes.MultiValueField() titles = indexes.MultiValueField() - + def get_model(self): return XapianMockModel - + def prepare_sites(self, obj): return ['%d' % (i * obj.id) for i in xrange(1, 4)] @@ -96,7 +94,6 @@ class XapianMockSearchIndex(indexes.SearchIndex): return ['object two title one', 'object two title two'] else: return ['object three title one', 'object three title two'] - pub_date = indexes.DateField(model_attr='pub_date') def prepare_month(self, obj): return '%02d' % obj.pub_date.month @@ -113,7 +110,7 @@ class XapianBoostMockSearchIndex(indexes.SearchIndex): author = indexes.CharField(model_attr='author', weight=2.0) editor = indexes.CharField(model_attr='editor') pub_date = indexes.DateField(model_attr='pub_date') - + def get_model(self): return AFourthMockModel @@ -121,16 +118,16 @@ class XapianBoostMockSearchIndex(indexes.SearchIndex): class XapianSearchBackendTestCase(TestCase): def setUp(self): super(XapianSearchBackendTestCase, self).setUp() - + self.old_ui = connections['default'].get_unified_index() self.ui = UnifiedIndex() self.index = XapianMockSearchIndex() self.ui.build(indexes=[self.index]) self.backend = connections['default'].get_backend() connections['default']._index = self.ui - + self.sample_objs = [] - + for i in xrange(1, 4): mock = XapianMockModel() mock.id = i @@ -142,70 +139,70 @@ class XapianSearchBackendTestCase(TestCase): mock.slug = 'http://example.com/%d/' % i mock.url = 'http://example.com/%d/' % i self.sample_objs.append(mock) - + self.sample_objs[0].popularity = 834.0 self.sample_objs[1].popularity = 35.5 self.sample_objs[2].popularity = 972.0 - + def tearDown(self): if os.path.exists(settings.HAYSTACK_CONNECTIONS['default']['PATH']): shutil.rmtree(settings.HAYSTACK_CONNECTIONS['default']['PATH']) - + connections['default']._index = self.old_ui super(XapianSearchBackendTestCase, self).tearDown() - + def test_update(self): self.backend.update(self.index, self.sample_objs) - + self.assertEqual(self.backend.document_count(), 3) self.assertEqual([result.pk for result in self.backend.search(xapian.Query(''))['results']], [1, 2, 3]) - + def test_duplicate_update(self): self.backend.update(self.index, self.sample_objs) - self.backend.update(self.index, self.sample_objs) # Duplicates should be updated, not appended -- http://github.com/notanumber/xapian-haystack/issues/#issue/6 - + self.backend.update(self.index, self.sample_objs) # Duplicates should be updated, not appended -- http://github.com/notanumber/xapian-haystack/issues/#issue/6 + self.assertEqual(self.backend.document_count(), 3) - + def test_remove(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.backend.remove(self.sample_objs[0]) self.assertEqual(self.backend.document_count(), 2) self.assertEqual([result.pk for result in self.backend.search(xapian.Query(''))['results']], [2, 3]) - + def test_clear(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.backend.clear() self.assertEqual(self.backend.document_count(), 0) - + self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.backend.clear([AnotherMockModel]) self.assertEqual(self.backend.document_count(), 3) - + self.backend.clear([XapianMockModel]) self.assertEqual(self.backend.document_count(), 0) - + self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.backend.clear([AnotherMockModel, XapianMockModel]) self.assertEqual(self.backend.document_count(), 0) - + def test_search(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query()), {'hits': 0, 'results': []}) self.assertEqual(self.backend.search(xapian.Query(''))['hits'], 3) self.assertEqual([result.pk for result in self.backend.search(xapian.Query(''))['results']], [1, 2, 3]) self.assertEqual(self.backend.search(xapian.Query('indexed'))['hits'], 3) self.assertEqual([result.pk for result in self.backend.search(xapian.Query(''))['results']], [1, 2, 3]) - + # Ensure that swapping the ``result_class`` works. self.assertTrue(isinstance(self.backend.search(xapian.Query('indexed'), result_class=MockSearchResult)['results'][0], MockSearchResult)) @@ -219,33 +216,33 @@ class XapianSearchBackendTestCase(TestCase): def test_search_by_mvf(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query('ab'))['hits'], 1) self.assertEqual(self.backend.search(xapian.Query('b'))['hits'], 1) self.assertEqual(self.backend.search(xapian.Query('to'))['hits'], 1) self.assertEqual(self.backend.search(xapian.Query('one'))['hits'], 3) - + def test_field_facets(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query(), facets=['name']), {'hits': 0, 'results': []}) results = self.backend.search(xapian.Query('indexed'), facets=['name']) self.assertEqual(results['hits'], 3) self.assertEqual(results['facets']['fields']['name'], [('david1', 1), ('david2', 1), ('david3', 1)]) - + results = self.backend.search(xapian.Query('indexed'), facets=['flag']) self.assertEqual(results['hits'], 3) self.assertEqual(results['facets']['fields']['flag'], [(False, 1), (True, 2)]) - + results = self.backend.search(xapian.Query('indexed'), facets=['sites']) self.assertEqual(results['hits'], 3) self.assertEqual(results['facets']['fields']['sites'], [('1', 1), ('3', 2), ('2', 2), ('4', 1), ('6', 2), ('9', 1)]) - + def test_date_facets(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query(), date_facets={'pub_date': {'start_date': datetime.datetime(2008, 10, 26), 'end_date': datetime.datetime(2009, 3, 26), 'gap_by': 'month'}}), {'hits': 0, 'results': []}) results = self.backend.search(xapian.Query('indexed'), date_facets={'pub_date': {'start_date': datetime.datetime(2008, 10, 26), 'end_date': datetime.datetime(2009, 3, 26), 'gap_by': 'month'}}) self.assertEqual(results['hits'], 3) @@ -256,7 +253,7 @@ class XapianSearchBackendTestCase(TestCase): ('2008-11-26T00:00:00', 0), ('2008-10-26T00:00:00', 0), ]) - + results = self.backend.search(xapian.Query('indexed'), date_facets={'pub_date': {'start_date': datetime.datetime(2009, 02, 01), 'end_date': datetime.datetime(2009, 3, 15), 'gap_by': 'day', 'gap_amount': 15}}) self.assertEqual(results['hits'], 3) self.assertEqual(results['facets']['dates']['pub_date'], [ @@ -264,107 +261,107 @@ class XapianSearchBackendTestCase(TestCase): ('2009-02-16T00:00:00', 3), ('2009-02-01T00:00:00', 0) ]) - + def test_query_facets(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query(), query_facets={'name': 'da*'}), {'hits': 0, 'results': []}) results = self.backend.search(xapian.Query('indexed'), query_facets={'name': 'da*'}) self.assertEqual(results['hits'], 3) self.assertEqual(results['facets']['queries']['name'], ('da*', 3)) - + def test_narrow_queries(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query(), narrow_queries=set(['name:david1'])), {'hits': 0, 'results': []}) results = self.backend.search(xapian.Query('indexed'), narrow_queries=set(['name:david1'])) self.assertEqual(results['hits'], 1) - + def test_highlight(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query(), highlight=True), {'hits': 0, 'results': []}) self.assertEqual(self.backend.search(xapian.Query('indexed'), highlight=True)['hits'], 3) self.assertEqual([result.highlighted['text'] for result in self.backend.search(xapian.Query('indexed'), highlight=True)['results']], ['indexed!\n1', 'indexed!\n2', 'indexed!\n3']) - + def test_spelling_suggestion(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + self.assertEqual(self.backend.search(xapian.Query('indxe'))['hits'], 0) self.assertEqual(self.backend.search(xapian.Query('indxe'))['spelling_suggestion'], 'indexed') - + self.assertEqual(self.backend.search(xapian.Query('indxed'))['hits'], 0) self.assertEqual(self.backend.search(xapian.Query('indxed'))['spelling_suggestion'], 'indexed') - + self.assertEqual(self.backend.search(xapian.Query('foo'))['hits'], 0) self.assertEqual(self.backend.search(xapian.Query('foo'), spelling_query='indexy')['spelling_suggestion'], 'indexed') - + self.assertEqual(self.backend.search(xapian.Query('XNAMEdavid'))['hits'], 0) self.assertEqual(self.backend.search(xapian.Query('XNAMEdavid'))['spelling_suggestion'], 'david1') - + def test_more_like_this(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + results = self.backend.more_like_this(self.sample_objs[0]) self.assertEqual(results['hits'], 2) self.assertEqual([result.pk for result in results['results']], [3, 2]) - + results = self.backend.more_like_this(self.sample_objs[0], additional_query=xapian.Query('david3')) self.assertEqual(results['hits'], 1) self.assertEqual([result.pk for result in results['results']], [3]) - + results = self.backend.more_like_this(self.sample_objs[0], limit_to_registered_models=True) self.assertEqual(results['hits'], 2) self.assertEqual([result.pk for result in results['results']], [3, 2]) - + # Ensure that swapping the ``result_class`` works. self.assertTrue(isinstance(self.backend.more_like_this(self.sample_objs[0], result_class=MockSearchResult)['results'][0], MockSearchResult)) - + def test_order_by(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) - + results = self.backend.search(xapian.Query(''), sort_by=['pub_date']) self.assertEqual([result.pk for result in results['results']], [3, 2, 1]) - + results = self.backend.search(xapian.Query(''), sort_by=['-pub_date']) self.assertEqual([result.pk for result in results['results']], [1, 2, 3]) - + results = self.backend.search(xapian.Query(''), sort_by=['exp_date']) self.assertEqual([result.pk for result in results['results']], [1, 2, 3]) - + results = self.backend.search(xapian.Query(''), sort_by=['-exp_date']) self.assertEqual([result.pk for result in results['results']], [3, 2, 1]) - + results = self.backend.search(xapian.Query(''), sort_by=['id']) self.assertEqual([result.pk for result in results['results']], [1, 2, 3]) - + results = self.backend.search(xapian.Query(''), sort_by=['-id']) self.assertEqual([result.pk for result in results['results']], [3, 2, 1]) - + results = self.backend.search(xapian.Query(''), sort_by=['value']) self.assertEqual([result.pk for result in results['results']], [1, 2, 3]) - + results = self.backend.search(xapian.Query(''), sort_by=['-value']) self.assertEqual([result.pk for result in results['results']], [3, 2, 1]) - + results = self.backend.search(xapian.Query(''), sort_by=['popularity']) self.assertEqual([result.pk for result in results['results']], [2, 1, 3]) - + results = self.backend.search(xapian.Query(''), sort_by=['-popularity']) self.assertEqual([result.pk for result in results['results']], [3, 1, 2]) - + results = self.backend.search(xapian.Query(''), sort_by=['flag', 'id']) self.assertEqual([result.pk for result in results['results']], [2, 1, 3]) - + results = self.backend.search(xapian.Query(''), sort_by=['flag', '-id']) self.assertEqual([result.pk for result in results['results']], [2, 3, 1]) - + def test_verify_type(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(self.backend.document_count(), 3) @@ -384,7 +381,7 @@ class XapianSearchBackendTestCase(TestCase): self.assertEqual(_marshal_value(datetime.datetime(2009, 5, 9, 0, 0)), u'20090509000000') self.assertEqual(_marshal_value(datetime.datetime(1899, 5, 18, 0, 0)), u'18990518000000') self.assertEqual(_marshal_value(datetime.datetime(2009, 5, 18, 1, 16, 30, 250)), u'20090518011630000250') - + def test_build_schema(self): (content_field_name, fields) = self.backend.build_schema(connections['default'].get_unified_index().all_searchfields()) self.assertEqual(content_field_name, 'text') @@ -406,7 +403,7 @@ class XapianSearchBackendTestCase(TestCase): {'column': 13, 'type': 'text', 'field_name': 'url', 'multi_valued': 'false'}, {'column': 14, 'type': 'long', 'field_name': 'value', 'multi_valued': 'false'} ]) - + def test_parse_query(self): self.backend.update(self.index, self.sample_objs) self.assertEqual(str(self.backend.parse_query('indexed')), 'Xapian::Query(Zindex:(pos=1))') @@ -430,7 +427,7 @@ class LiveXapianMockSearchIndex(indexes.SearchIndex): pub_date = indexes.DateField(model_attr='pub_date') created = indexes.DateField() title = indexes.CharField() - + def get_model(self): return MockModel @@ -440,10 +437,10 @@ class LiveXapianSearchQueryTestCase(TestCase): SearchQuery specific tests """ fixtures = ['initial_data.json'] - + def setUp(self): super(LiveXapianSearchQueryTestCase, self).setUp() - + self.old_ui = connections['default'].get_unified_index() ui = UnifiedIndex() index = LiveXapianMockSearchIndex() @@ -451,38 +448,38 @@ class LiveXapianSearchQueryTestCase(TestCase): backend = connections['default'].get_backend() connections['default']._index = ui backend.update(index, MockModel.objects.all()) - + self.sq = connections['default'].get_query() - + def tearDown(self): connections['default']._index = self.old_ui super(LiveXapianSearchQueryTestCase, self).tearDown() - + def test_get_spelling(self): self.sq.add_filter(SQ(content='indxd')) self.assertEqual(self.sq.get_spelling_suggestion(), u'indexed') self.assertEqual(self.sq.get_spelling_suggestion('indxd'), u'indexed') - + def test_startswith(self): self.sq.add_filter(SQ(name__startswith='da')) self.assertEqual([result.pk for result in self.sq.get_results()], [1, 2, 3]) - + def test_build_query_gt(self): self.sq.add_filter(SQ(name__gt='m')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT VALUE_RANGE 2 a m))') - + def test_build_query_gte(self): self.sq.add_filter(SQ(name__gte='m')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(VALUE_RANGE 2 m zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz)') - + def test_build_query_lt(self): self.sq.add_filter(SQ(name__lt='m')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT VALUE_RANGE 2 m zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz))') - + def test_build_query_lte(self): self.sq.add_filter(SQ(name__lte='m')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(VALUE_RANGE 2 a m)') - + def test_build_query_multiple_filter_types(self): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(SQ(pub_date__lte=datetime.datetime(2009, 2, 10, 1, 59, 0))) @@ -491,18 +488,18 @@ class LiveXapianSearchQueryTestCase(TestCase): self.sq.add_filter(SQ(title__gte='B')) self.sq.add_filter(SQ(id__in=[1, 2, 3])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND VALUE_RANGE 3 00010101000000 20090210015900 AND ( AND_NOT VALUE_RANGE 2 a david) AND ( AND_NOT VALUE_RANGE 1 20090212121300 99990101000000) AND VALUE_RANGE 5 b zzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzzz AND (Q1 OR Q2 OR Q3)))') - + def test_log_query(self): reset_search_queries() self.assertEqual(len(connections['default'].queries), 0) - + # Stow. old_debug = settings.DEBUG settings.DEBUG = False - + len(self.sq.get_results()) self.assertEqual(len(connections['default'].queries), 0) - + settings.DEBUG = True # Redefine it to clear out the cached results. self.sq = connections['default'].get_query() @@ -510,7 +507,7 @@ class LiveXapianSearchQueryTestCase(TestCase): len(self.sq.get_results()) self.assertEqual(len(connections['default'].queries), 1) self.assertEqual(str(connections['default'].queries[0]['query_string']), u'Xapian::Query((ZXNAMEbar OR XNAMEbar))') - + # And again, for good measure. self.sq = connections['default'].get_query() self.sq.add_filter(SQ(name='bar')) @@ -519,7 +516,7 @@ class LiveXapianSearchQueryTestCase(TestCase): self.assertEqual(len(connections['default'].queries), 2) self.assertEqual(str(connections['default'].queries[0]['query_string']), u'Xapian::Query((ZXNAMEbar OR XNAMEbar))') self.assertEqual(str(connections['default'].queries[1]['query_string']), u'Xapian::Query(((ZXNAMEbar OR XNAMEbar) AND (ZXTEXTmoof OR XTEXTmoof)))') - + # Restore. settings.DEBUG = old_debug @@ -529,10 +526,10 @@ class LiveXapianSearchQuerySetTestCase(TestCase): SearchQuerySet specific tests """ fixtures = ['initial_data.json'] - + def setUp(self): super(LiveXapianSearchQuerySetTestCase, self).setUp() - + self.old_ui = connections['default'].get_unified_index() self.ui = UnifiedIndex() self.index = LiveXapianMockSearchIndex() @@ -540,23 +537,23 @@ class LiveXapianSearchQuerySetTestCase(TestCase): self.backend = connections['default'].get_backend() connections['default']._index = self.ui self.backend.update(self.index, MockModel.objects.all()) - + self.sq = connections['default'].get_query() self.sqs = SearchQuerySet() - + def tearDown(self): connections['default']._index = self.old_ui super(LiveXapianSearchQuerySetTestCase, self).tearDown() - + def test_result_class(self): # Assert that we're defaulting to ``SearchResult``. sqs = self.sqs.all() self.assertTrue(isinstance(sqs[0], SearchResult)) - + # Custom class. sqs = self.sqs.result_class(MockSearchResult).all() self.assertTrue(isinstance(sqs[0], MockSearchResult)) - + # Reset to default. sqs = self.sqs.result_class(None).all() self.assertTrue(isinstance(sqs[0], SearchResult)) @@ -565,7 +562,7 @@ class LiveXapianSearchQuerySetTestCase(TestCase): class XapianBoostBackendTestCase(TestCase): def setUp(self): super(XapianBoostBackendTestCase, self).setUp() - + # Stow. self.old_ui = connections['default'].get_unified_index() self.ui = UnifiedIndex() @@ -594,9 +591,9 @@ class XapianBoostBackendTestCase(TestCase): def test_boost(self): self.sb.update(self.index, self.sample_objs) - + sqs = SearchQuerySet() - + self.assertEqual(len(sqs.all()), 4) results = sqs.filter(SQ(author='daniel') | SQ(editor='daniel')) diff --git a/xapian_backend.py b/xapian_backend.py index b77a287..69e36b9 100755 --- a/xapian_backend.py +++ b/xapian_backend.py @@ -11,7 +11,6 @@ import os import re import shutil import sys -import warnings from django.conf import settings from django.core.exceptions import ImproperlyConfigured @@ -19,9 +18,8 @@ from django.utils.encoding import force_unicode from haystack import connections from haystack.backends import BaseEngine, BaseSearchBackend, BaseSearchQuery, SearchNode, log_query -from haystack.constants import ID, DJANGO_CT, DJANGO_ID -from haystack.exceptions import HaystackError, MissingDependency, MoreLikeThisError -from haystack.fields import DateField, DateTimeField, IntegerField, FloatField, BooleanField, MultiValueField +from haystack.constants import ID +from haystack.exceptions import HaystackError, MissingDependency from haystack.models import SearchResult from haystack.utils import get_identifier @@ -36,7 +34,7 @@ DOCUMENT_CUSTOM_TERM_PREFIX = 'X' DOCUMENT_CT_TERM_PREFIX = DOCUMENT_CUSTOM_TERM_PREFIX + 'CONTENTTYPE' DEFAULT_XAPIAN_FLAGS = ( - xapian.QueryParser.FLAG_PHRASE | + xapian.QueryParser.FLAG_PHRASE | xapian.QueryParser.FLAG_BOOLEAN | xapian.QueryParser.FLAG_LOVEHATE | xapian.QueryParser.FLAG_WILDCARD | @@ -54,7 +52,7 @@ class XHValueRangeProcessor(xapian.ValueRangeProcessor): # FIXME: This needs to get smarter about pulling the right backend. self.backend = backend or XapianSearchBackend() xapian.ValueRangeProcessor.__init__(self) - + def __call__(self, begin, end): """ Construct a tuple for value range processing. @@ -71,7 +69,7 @@ class XHValueRangeProcessor(xapian.ValueRangeProcessor): if field_dict['field_name'] == field_name: if not begin: if field_dict['type'] == 'text': - begin = u'a' # TODO: A better way of getting a min text value? + begin = u'a' # TODO: A better way of getting a min text value? elif field_dict['type'] == 'long': begin = -sys.maxint - 1 elif field_dict['type'] == 'float': @@ -80,7 +78,7 @@ class XHValueRangeProcessor(xapian.ValueRangeProcessor): begin = u'00010101000000' elif end == '*': if field_dict['type'] == 'text': - end = u'z' * 100 # TODO: A better way of getting a max text value? + end = u'z' * 100 # TODO: A better way of getting a max text value? elif field_dict['type'] == 'long': end = sys.maxint elif field_dict['type'] == 'float': @@ -101,7 +99,7 @@ class XHExpandDecider(xapian.ExpandDecider): """ Return True if the term should be used for expanding the search query, False otherwise. - + Currently, we only want to ignore terms beginning with `DOCUMENT_CT_TERM_PREFIX` """ if term.startswith(DOCUMENT_CT_TERM_PREFIX): @@ -113,15 +111,15 @@ class XapianSearchBackend(BaseSearchBackend): """ `SearchBackend` defines the Xapian search backend for use with the Haystack API for Django search. - + It uses the Xapian Python bindings to interface with Xapian, and as such is subject to this bug: when Django is running with mod_python or mod_wsgi under Apache. - + Until this issue has been fixed by Xapian, it is neccessary to set `WSGIApplicationGroup to %{GLOBAL}` when using mod_wsgi, or `PythonInterpreter main_interpreter` when using mod_python. - + In order to use this backend, `PATH` must be included in the `connection_options`. This should point to a location where you would your indexes to reside. @@ -129,74 +127,74 @@ class XapianSearchBackend(BaseSearchBackend): def __init__(self, connection_alias, language='english', **connection_options): """ Instantiates an instance of `SearchBackend`. - + Optional arguments: `connection_alias` -- The name of the connection `language` -- The stemming language (default = 'english') `**connection_options` -- The various options needed to setup the backend. - + Also sets the stemming language to be used to `language`. """ super(XapianSearchBackend, self).__init__(connection_alias, **connection_options) - + if not 'PATH' in connection_options: raise ImproperlyConfigured("You must specify a 'PATH' in your settings for connection '%s'." % connection_alias) - + self.path = connection_options.get('PATH') - + if not os.path.exists(self.path): os.makedirs(self.path) - + self.flags = connection_options.get('FLAGS', DEFAULT_XAPIAN_FLAGS) self.language = language self._schema = None self._content_field_name = None - + @property def schema(self): if not self._schema: - self._content_field_name, self._schema = self.build_schema(connections[self.connection_alias].get_unified_index().all_searchfields()) + self._content_field_name, self._schema = self.build_schema(connections[self.connection_alias].get_unified_index().all_searchfields()) return self._schema @property def content_field_name(self): if not self._content_field_name: - self._content_field_name, self._schema = self.build_schema(connections[self.connection_alias].get_unified_index().all_searchfields()) + self._content_field_name, self._schema = self.build_schema(connections[self.connection_alias].get_unified_index().all_searchfields()) return self._content_field_name - + def update(self, index, iterable): """ Updates the `index` with any objects in `iterable` by adding/updating the database as needed. - + Required arguments: `index` -- The `SearchIndex` to process `iterable` -- An iterable of model instances to index - + For each object in `iterable`, a document is created containing all - of the terms extracted from `index.full_prepare(obj)` with field prefixes, - and 'as-is' as needed. Also, if the field type is 'text' it will be + of the terms extracted from `index.full_prepare(obj)` with field prefixes, + and 'as-is' as needed. Also, if the field type is 'text' it will be stemmed and stored with the 'Z' prefix as well. - + eg. `content:Testing` ==> `testing, Ztest, ZXCONTENTtest, XCONTENTtest` - + Each document also contains an extra term in the format: - + `XCONTENTTYPE.` - + As well as a unique identifier in the the format: - + `Q..` - + eg.: foo.bar (pk=1) ==> `Qfoo.bar.1`, `XCONTENTTYPEfoo.bar` - + This is useful for querying for a specific document corresponding to a model instance. - + The document also contains a pickled version of the object itself and the document ID in the document data field. - + Finally, we also store field values to be used for sorting data. We store these in the document value slots (position zero is reserver for the document ID). All values are stored as unicode strings with @@ -207,14 +205,14 @@ class XapianSearchBackend(BaseSearchBackend): try: for obj in iterable: document = xapian.Document() - + term_generator = xapian.TermGenerator() term_generator.set_database(database) term_generator.set_stemmer(xapian.Stem(self.language)) if self.include_spelling is True: term_generator.set_flags(xapian.TermGenerator.FLAG_SPELLING) term_generator.set_document(document) - + document_id = DOCUMENT_ID_TERM_PREFIX + get_identifier(obj) data = index.full_prepare(obj) weights = index.get_field_weights() @@ -256,7 +254,7 @@ class XapianSearchBackend(BaseSearchBackend): if len(term.split()) == 1: document.add_term(term, weight) document.add_term(prefix + term, weight) - + document.set_data(pickle.dumps( (obj._meta.app_label, obj._meta.module_name, obj.pk, data), pickle.HIGHEST_PROTOCOL @@ -267,35 +265,35 @@ class XapianSearchBackend(BaseSearchBackend): (obj._meta.app_label, obj._meta.module_name) ) database.replace_document(document_id, document) - + except UnicodeDecodeError: sys.stderr.write('Chunk failed.\n') pass - + finally: database = None - + def remove(self, obj): """ Remove indexes for `obj` from the database. - + We delete all instances of `Q..` which should be unique to this object. """ database = self._database(writable=True) database.delete_document(DOCUMENT_ID_TERM_PREFIX + get_identifier(obj)) - + def clear(self, models=[]): """ Clear all instances of `models` from the database or all models, if not specified. - + Optional Arguments: `models` -- Models to clear from the database (default = []) - + If `models` is empty, an empty query is executed which matches all documents in the database. Afterwards, each match is deleted. - + Otherwise, for each model, a `delete_document` call is issued with the term `XCONTENTTYPE.`. This will delete all documents with the specified model type. @@ -327,10 +325,10 @@ class XapianSearchBackend(BaseSearchBackend): limit_to_registered_models=True, result_class=None, **kwargs): """ Executes the Xapian::query as defined in `query`. - + Required arguments: `query` -- Search query to execute - + Optional arguments: `sort_by` -- Sort results by specified field (default = None) `start_offset` -- Slice results from `start_offset` (default = 0) @@ -343,7 +341,7 @@ class XapianSearchBackend(BaseSearchBackend): `narrow_queries` -- Narrow queries (default = None) `spelling_query` -- An optional query to execute spelling suggestion on `limit_to_registered_models` -- Limit returned results to models registered in the current `SearchSite` (default = True) - + Returns: A dictionary with the following keys: `results` -- A list of `SearchResult` @@ -353,9 +351,9 @@ class XapianSearchBackend(BaseSearchBackend): `dates` -- A list of date facets `queries` -- A list of query facets If faceting was not used, the `facets` key will not be present - + If `query` is None, returns no results. - + If `INCLUDE_SPELLING` was enabled in the connection options, the extra flag `FLAG_SPELLING_CORRECTION` will be passed to the query parser and any suggestions for spell correction will be returned as well as @@ -366,27 +364,27 @@ class XapianSearchBackend(BaseSearchBackend): 'results': [], 'hits': 0, } - + database = self._database() - + if result_class is None: result_class = SearchResult - + if self.include_spelling is True: spelling_suggestion = self._do_spelling_suggestion(database, query, spelling_query) else: spelling_suggestion = '' - + if narrow_queries is not None: query = xapian.Query( xapian.Query.OP_AND, query, xapian.Query( xapian.Query.OP_OR, [self.parse_query(narrow_query) for narrow_query in narrow_queries] ) ) - + if limit_to_registered_models: registered_models = self.build_models_list() - + if len(registered_models) > 0: query = xapian.Query( xapian.Query.OP_AND, query, @@ -396,37 +394,37 @@ class XapianSearchBackend(BaseSearchBackend): ] ) ) - + enquire = xapian.Enquire(database) if hasattr(settings, 'HAYSTACK_XAPIAN_WEIGHTING_SCHEME'): enquire.set_weighting_scheme(xapian.BM25Weight(*settings.HAYSTACK_XAPIAN_WEIGHTING_SCHEME)) enquire.set_query(query) - + if sort_by: sorter = xapian.MultiValueSorter() - + for sort_field in sort_by: if sort_field.startswith('-'): reverse = True - sort_field = sort_field[1:] # Strip the '-' + sort_field = sort_field[1:] # Strip the '-' else: - reverse = False # Reverse is inverted in Xapian -- http://trac.xapian.org/ticket/311 + reverse = False # Reverse is inverted in Xapian -- http://trac.xapian.org/ticket/311 sorter.add(self._value_column(sort_field), reverse) - + enquire.set_sort_by_key_then_relevance(sorter, True) - + results = [] facets_dict = { 'fields': {}, 'dates': {}, 'queries': {}, } - + if not end_offset: end_offset = database.get_doccount() - start_offset - + matches = self._get_enquire_mset(database, enquire, start_offset, end_offset) - + for match in matches: app_label, module_name, pk, model_data = pickle.loads(self._get_document_data(database, match.document)) if highlight: @@ -438,71 +436,71 @@ class XapianSearchBackend(BaseSearchBackend): results.append( result_class(app_label, module_name, pk, match.percent, **model_data) ) - + if facets: facets_dict['fields'] = self._do_field_facets(results, facets) if date_facets: facets_dict['dates'] = self._do_date_facets(results, date_facets) if query_facets: facets_dict['queries'] = self._do_query_facets(results, query_facets) - + return { 'results': results, 'hits': self._get_hit_count(database, enquire), 'facets': facets_dict, 'spelling_suggestion': spelling_suggestion, } - + def more_like_this(self, model_instance, additional_query=None, start_offset=0, end_offset=None, limit_to_registered_models=True, result_class=None, **kwargs): """ Given a model instance, returns a result set of similar documents. - + Required arguments: `model_instance` -- The model instance to use as a basis for retrieving similar documents. - + Optional arguments: `additional_query` -- An additional query to narrow results `start_offset` -- The starting offset (default=0) `end_offset` -- The ending offset (default=None), if None, then all documents `limit_to_registered_models` -- Limit returned results to models registered in the current `SearchSite` (default = True) - + Returns: A dictionary with the following keys: `results` -- A list of `SearchResult` `hits` -- The total available results - + Opens a database connection, then builds a simple query using the `model_instance` to build the unique identifier. - + For each document retrieved(should always be one), adds an entry into an RSet (relevance set) with the document id, then, uses the RSet to query for an ESet (A set of terms that can be used to suggest expansions to the original query), omitting any document that was in the original query. - + Finally, processes the resulting matches and returns. """ database = self._database() - + if result_class is None: result_class = SearchResult - + query = xapian.Query(DOCUMENT_ID_TERM_PREFIX + get_identifier(model_instance)) - + enquire = xapian.Enquire(database) enquire.set_query(query) - + rset = xapian.RSet() - + if not end_offset: end_offset = database.get_doccount() - + for match in self._get_enquire_mset(database, enquire, 0, end_offset): rset.add_document(match.docid) - + query = xapian.Query( xapian.Query.OP_ELITE_SET, [expand.term for expand in enquire.get_eset(match.document.termlist_count(), rset, XHExpandDecider())], @@ -513,7 +511,7 @@ class XapianSearchBackend(BaseSearchBackend): ) if limit_to_registered_models: registered_models = self.build_models_list() - + if len(registered_models) > 0: query = xapian.Query( xapian.Query.OP_AND, query, @@ -527,12 +525,12 @@ class XapianSearchBackend(BaseSearchBackend): query = xapian.Query( xapian.Query.OP_AND, query, additional_query ) - + enquire.set_query(query) - + results = [] matches = self._get_enquire_mset(database, enquire, start_offset, end_offset) - + for match in matches: app_label, module_name, pk, model_data = pickle.loads(self._get_document_data(database, match.document)) results.append( @@ -549,21 +547,21 @@ class XapianSearchBackend(BaseSearchBackend): }, 'spelling_suggestion': None, } - + def parse_query(self, query_string): """ Given a `query_string`, will attempt to return a xapian.Query - + Required arguments: ``query_string`` -- A query string to parse - + Returns a xapian.Query """ if query_string == '*': - return xapian.Query('') # Match everything + return xapian.Query('') # Match everything elif query_string == '': - return xapian.Query() # Match nothing - + return xapian.Query() # Match nothing + qp = xapian.QueryParser() qp.set_database(self._database()) qp.set_stemmer(xapian.Stem(self.language)) @@ -575,19 +573,19 @@ class XapianSearchBackend(BaseSearchBackend): field_dict['field_name'], DOCUMENT_CUSTOM_TERM_PREFIX + field_dict['field_name'].upper() ) - + vrp = XHValueRangeProcessor(self) qp.add_valuerangeprocessor(vrp) - + return qp.parse_query(query_string, self.flags) - + def build_schema(self, fields): """ Build the schema from fields. - + Required arguments: ``fields`` -- A list of fields in the index - + Returns a list of fields in dictionary format ready for inclusion in an indexed meta-data. """ @@ -596,11 +594,11 @@ class XapianSearchBackend(BaseSearchBackend): {'field_name': ID, 'type': 'text', 'multi_valued': 'false', 'column': 0}, ] column = len(schema_fields) - + for field_name, field_class in sorted(fields.items(), key=lambda n: n[0]): if field_class.document is True: content_field_name = field_class.index_fieldname - + if field_class.indexed is True: field_data = { 'field_name': field_class.index_fieldname, @@ -608,7 +606,7 @@ class XapianSearchBackend(BaseSearchBackend): 'multi_valued': 'false', 'column': column, } - + if field_class.field_type in ['date', 'datetime']: field_data['type'] = 'date' elif field_class.field_type == 'integer': @@ -617,81 +615,81 @@ class XapianSearchBackend(BaseSearchBackend): field_data['type'] = 'float' elif field_class.field_type == 'boolean': field_data['type'] = 'boolean' - + if field_class.is_multivalued: field_data['multi_valued'] = 'true' - + schema_fields.append(field_data) column += 1 return (content_field_name, schema_fields) - + def _do_highlight(self, content, query, tag='em'): """ Highlight `query` terms in `content` with html `tag`. - + This method assumes that the input text (`content`) does not contain any special formatting. That is, it does not contain any html tags or similar markup that could be screwed up by the highlighting. - + Required arguments: `content` -- Content to search for instances of `text` `text` -- The text to be highlighted """ for term in query: - for match in re.findall('[^A-Z]+', term): # Ignore field identifiers + for match in re.findall('[^A-Z]+', term): # Ignore field identifiers match_re = re.compile(match, re.I) content = match_re.sub('<%s>%s' % (tag, term, tag), content) - + return content - + def _do_field_facets(self, results, field_facets): """ Private method that facets a document by field name. - + Fields of type MultiValueField will be faceted on each item in the (containing) list. - + Required arguments: `results` -- A list SearchResults to facet `field_facets` -- A list of fields to facet on """ facet_dict = {} - + # DS_TODO: Improve this algorithm. Currently, runs in O(N^2), ouch. for field in field_facets: facet_list = {} - + for result in results: field_value = getattr(result, field) if self._multi_value_field(field): - for item in field_value: # Facet each item in a MultiValueField + for item in field_value: # Facet each item in a MultiValueField facet_list[item] = facet_list.get(item, 0) + 1 else: facet_list[field_value] = facet_list.get(field_value, 0) + 1 - + facet_dict[field] = facet_list.items() - + return facet_dict - + def _do_date_facets(self, results, date_facets): """ Private method that facets a document by date ranges - + Required arguments: `results` -- A list SearchResults to facet `date_facets` -- A dictionary containing facet parameters: {'field': {'start_date': ..., 'end_date': ...: 'gap_by': '...', 'gap_amount': n}} nb., gap must be one of the following: year|month|day|hour|minute|second - + For each date facet field in `date_facets`, generates a list of date ranges (from `start_date` to `end_date` by `gap_by`) then iterates through `results` and tallies the count for each date_facet. - + Returns a dictionary of date facets (fields) containing a list with entries for each range and a count of documents matching the range. - + eg. { 'pub_date': [ ('2009-01-01T00:00:00Z', 5), @@ -703,7 +701,7 @@ class XapianSearchBackend(BaseSearchBackend): } """ facet_dict = {} - + for date_facet, facet_params in date_facets.iteritems(): gap_type = facet_params.get('gap_by') gap_value = facet_params.get('gap_amount', 1) @@ -733,9 +731,9 @@ class XapianSearchBackend(BaseSearchBackend): date_range += datetime.timedelta(minutes=int(gap_value)) elif gap_type == 'second': date_range += datetime.timedelta(seconds=int(gap_value)) - - facet_list = sorted(facet_list, key=lambda n:n[0], reverse=True) - + + facet_list = sorted(facet_list, key=lambda n: n[0], reverse=True) + for result in results: result_date = getattr(result, date_facet) if result_date: @@ -749,43 +747,43 @@ class XapianSearchBackend(BaseSearchBackend): if result_date > datetime.datetime(*(time.strptime(facet_date[0], '%Y-%m-%dT%H:%M:%S')[0:6])): facet_list[n] = (facet_list[n][0], (facet_list[n][1] + 1)) break - + facet_dict[date_facet] = facet_list - + return facet_dict - + def _do_query_facets(self, results, query_facets): """ Private method that facets a document by query - + Required arguments: `results` -- A list SearchResults to facet `query_facets` -- A dictionary containing facet parameters: {'field': 'query', [...]} - + For each query in `query_facets`, generates a dictionary entry with the field name as the key and a tuple with the query and result count as the value. - + eg. {'name': ('a*', 5)} """ facet_dict = {} - + for field, query in query_facets.iteritems(): facet_dict[field] = (query, self.search(self.parse_query(query))['hits']) return facet_dict - + def _do_spelling_suggestion(self, database, query, spelling_query): """ Private method that returns a single spelling suggestion based on `spelling_query` or `query`. - + Required arguments: `database` -- The database to check spelling against `query` -- The query to check `spelling_query` -- If not None, this will be checked instead of `query` - + Returns a string with a suggested spelling """ if spelling_query: @@ -793,14 +791,14 @@ class XapianSearchBackend(BaseSearchBackend): return ' '.join([database.get_spelling_suggestion(term) for term in spelling_query.split()]) else: return database.get_spelling_suggestion(spelling_query) - + term_set = set() for term in query: - for match in re.findall('[^A-Z]+', term): # Ignore field identifiers + for match in re.findall('[^A-Z]+', term): # Ignore field identifiers term_set.add(database.get_spelling_suggestion(match)) - + return ' '.join(term_set) - + def _database(self, writable=False): """ Private method that returns a xapian.Database for use. @@ -860,7 +858,7 @@ class XapianSearchBackend(BaseSearchBackend): """ Given a database and enquire instance, returns the estimated number of matches. - + Required arguments: `database` -- The database to be queried `enquire` -- The enquire instance @@ -873,25 +871,25 @@ class XapianSearchBackend(BaseSearchBackend): """ Private method that returns the column value slot in the database for a given field. - + Required arguemnts: `field` -- The field to lookup - + Returns an integer with the column location (0 indexed). """ for field_dict in self.schema: if field_dict['field_name'] == field: return field_dict['column'] return 0 - + def _multi_value_field(self, field): """ Private method that returns `True` if a field is multi-valued, else `False`. - + Required arguemnts: `field` -- The field to lookup - + Returns a boolean value indicating whether the field is multi-valued. """ for field_dict in self.schema: @@ -911,7 +909,7 @@ class XapianSearchQuery(BaseSearchQuery): if self.end_offset is not None: kwargs['end_offset'] = self.end_offset - self.start_offset - + return kwargs def build_query(self): @@ -919,7 +917,7 @@ class XapianSearchQuery(BaseSearchQuery): query = xapian.Query('') else: query = self._query_from_search_node(self.query_filter) - + if self.models: subqueries = [ xapian.Query( @@ -927,14 +925,14 @@ class XapianSearchQuery(BaseSearchQuery): DOCUMENT_CT_TERM_PREFIX, model._meta.app_label, model._meta.module_name ) - ), 0 # Pure boolean sub-query + ), 0 # Pure boolean sub-query ) for model in self.models ] query = xapian.Query( xapian.Query.OP_AND, query, xapian.Query(xapian.Query.OP_OR, subqueries) ) - + if self.boost: subqueries = [ xapian.Query( @@ -945,12 +943,12 @@ class XapianSearchQuery(BaseSearchQuery): xapian.Query.OP_AND_MAYBE, query, xapian.Query(xapian.Query.OP_OR, subqueries) ) - + return query - + def _query_from_search_node(self, search_node, is_not=False): query_list = [] - + for child in search_node.children: if isinstance(child, SearchNode): query_list.append( @@ -959,16 +957,16 @@ class XapianSearchQuery(BaseSearchQuery): else: expression, term = child field, filter_type = search_node.split_expression(expression) - + # Handle when we've got a ``ValuesListQuerySet``... if hasattr(term, 'values_list'): term = list(term) - + if isinstance(term, (list, tuple)): term = [_marshal_term(t) for t in term] else: term = _marshal_term(term) - + if field == 'content': query_list.append(self._content_field(term, is_not)) else: @@ -986,21 +984,21 @@ class XapianSearchQuery(BaseSearchQuery): query_list.append(self._filter_startswith(term, field, is_not)) elif filter_type == 'in': query_list.append(self._filter_in(term, field, is_not)) - + if search_node.connector == 'OR': return xapian.Query(xapian.Query.OP_OR, query_list) else: return xapian.Query(xapian.Query.OP_AND, query_list) - + def _content_field(self, term, is_not): """ Private method that returns a xapian.Query that searches for `value` in all fields. - + Required arguments: ``term`` -- The term to search for ``is_not`` -- Invert the search results - + Returns: A xapian.Query """ @@ -1018,17 +1016,17 @@ class XapianSearchQuery(BaseSearchQuery): return xapian.Query(xapian.Query.OP_AND_NOT, self._all_query(), self._term_query(term)) else: return self._term_query(term) - + def _filter_exact(self, term, field, is_not): """ Private method that returns a xapian.Query that searches for `term` in a specified `field`. - + Required arguments: ``term`` -- The term to search for ``field`` -- The field to search ``is_not`` -- Invert the search results - + Returns: A xapian.Query """ @@ -1044,17 +1042,17 @@ class XapianSearchQuery(BaseSearchQuery): return xapian.Query(xapian.Query.OP_AND_NOT, self._all_query(), self._term_query(term, field)) else: return self._term_query(term, field) - + def _filter_in(self, term_list, field, is_not): """ Private method that returns a xapian.Query that searches for any term of `value_list` in a specified `field`. - + Required arguments: ``term_list`` -- The terms to search for ``field`` -- The field to search ``is_not`` -- Invert the search results - + Returns: A xapian.Query """ @@ -1072,17 +1070,17 @@ class XapianSearchQuery(BaseSearchQuery): return xapian.Query(xapian.Query.OP_AND_NOT, self._all_query(), xapian.Query(xapian.Query.OP_OR, query_list)) else: return xapian.Query(xapian.Query.OP_OR, query_list) - + def _filter_startswith(self, term, field, is_not): """ Private method that returns a xapian.Query that searches for any term that begins with `term` in a specified `field`. - + Required arguments: ``term`` -- The terms to search for ``field`` -- The field to search ``is_not`` -- Invert the search results - + Returns: A xapian.Query """ @@ -1093,10 +1091,10 @@ class XapianSearchQuery(BaseSearchQuery): self.backend.parse_query('%s:%s*' % (field, term)), ) return self.backend.parse_query('%s:%s*' % (field, term)) - + def _filter_gt(self, term, field, is_not): return self._filter_lte(term, field, is_not=(is_not != True)) - + def _filter_lt(self, term, field, is_not): return self._filter_gte(term, field, is_not=(is_not != True)) @@ -1113,7 +1111,7 @@ class XapianSearchQuery(BaseSearchQuery): xapian.Query(xapian.Query.OP_VALUE_RANGE, pos, begin, end) ) return xapian.Query(xapian.Query.OP_VALUE_RANGE, pos, begin, end) - + def _filter_lte(self, term, field, is_not): """ Private method that returns a xapian.Query that searches for any term @@ -1131,26 +1129,26 @@ class XapianSearchQuery(BaseSearchQuery): def _all_query(self): """ Private method that returns a xapian.Query that returns all documents, - + Returns: A xapian.Query """ return xapian.Query('') - + def _term_query(self, term, field=None): """ Private method that returns a term based xapian.Query that searches for `term`. - + Required arguments: ``term`` -- The term to search for ``field`` -- The field to search (If `None`, all fields) - + Returns: A xapian.Query """ stem = xapian.Stem(self.backend.language) - + if field == 'id': return xapian.Query('%s%s' % (DOCUMENT_ID_TERM_PREFIX, term)) elif field == 'django_ct': @@ -1165,22 +1163,22 @@ class XapianSearchQuery(BaseSearchQuery): else: stemmed = 'Z%s' % stem(term) unstemmed = term - + return xapian.Query( xapian.Query.OP_OR, xapian.Query(stemmed), xapian.Query(unstemmed) ) - + def _phrase_query(self, term_list, field=None): """ Private method that returns a phrase based xapian.Query that searches for terms in `term_list. - + Required arguments: ``term_list`` -- The terms to search for ``field`` -- The field to search (If `None`, all fields) - + Returns: A xapian.Query """ From 9fff70d652f1f16ef58736a1fd56d9f8e8c3e9ed Mon Sep 17 00:00:00 2001 From: David Sauve Date: Fri, 20 Apr 2012 11:53:06 -0700 Subject: [PATCH 14/14] Updated documentation for 2.0.X --- README.rst | 18 ++++--- tests/xapian_settings.py | 2 +- tests/xapian_tests/__init__.py | 2 +- tests/xapian_tests/models.py | 2 +- tests/xapian_tests/tests/__init__.py | 2 +- tests/xapian_tests/tests/xapian_backend.py | 2 +- tests/xapian_tests/tests/xapian_query.py | 62 +++++++++++----------- 7 files changed, 48 insertions(+), 42 deletions(-) diff --git a/README.rst b/README.rst index 6310ba3..fa91463 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ Requirements - Python 2.4 (May work with 2.3, but untested) - Django 1.0.x -- Django-Haystack 1.1.X (If you wish to use django-haystack 1.0.X, please use xapian-haystack 1.0.X) +- Django-Haystack 2.0.X - Xapian 1.0.13+ (May work with earlier versions, but untested) Notes @@ -33,13 +33,19 @@ Installation or ``pip install xapian-haystack`` - + or ``easy_install xapian-haystack`` -#. Add ``HAYSTACK_XAPIAN_PATH`` to ``settings.py`` -#. Set ``HAYSTACK_SEARCH_ENGINE`` to ``xapian`` +#. Set to something similar to: + + HAYSTACK_CONNECTIONS = { + 'default': { + 'ENGINE': 'haystack.backends.xapian_backend.XapianEngine', + 'PATH': os.path.join(os.path.dirname(__file__), 'xapian_index') + }, + } Configuration ------------- @@ -96,10 +102,10 @@ xapian-haystack is maintained by `David Sauve `_ -Alternatively, ask questions on the django-haystack `mailing list `_ or `irc channel `_. \ No newline at end of file +Alternatively, ask questions on the django-haystack `mailing list `_ or `irc channel `_. diff --git a/tests/xapian_settings.py b/tests/xapian_settings.py index 262136c..d3100c1 100755 --- a/tests/xapian_settings.py +++ b/tests/xapian_settings.py @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze import os diff --git a/tests/xapian_tests/__init__.py b/tests/xapian_tests/__init__.py index d0dcb66..51c415e 100644 --- a/tests/xapian_tests/__init__.py +++ b/tests/xapian_tests/__init__.py @@ -1,2 +1,2 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze diff --git a/tests/xapian_tests/models.py b/tests/xapian_tests/models.py index d0dcb66..51c415e 100644 --- a/tests/xapian_tests/models.py +++ b/tests/xapian_tests/models.py @@ -1,2 +1,2 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze diff --git a/tests/xapian_tests/tests/__init__.py b/tests/xapian_tests/tests/__init__.py index 13030c7..2f3d98f 100644 --- a/tests/xapian_tests/tests/__init__.py +++ b/tests/xapian_tests/tests/__init__.py @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze import warnings diff --git a/tests/xapian_tests/tests/xapian_backend.py b/tests/xapian_tests/tests/xapian_backend.py index 3acab67..44d183c 100644 --- a/tests/xapian_tests/tests/xapian_backend.py +++ b/tests/xapian_tests/tests/xapian_backend.py @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze # Based on original code by Daniel Lindsley as part of the Haystack test suite. diff --git a/tests/xapian_tests/tests/xapian_query.py b/tests/xapian_tests/tests/xapian_query.py index cf92d5a..eebf746 100644 --- a/tests/xapian_tests/tests/xapian_query.py +++ b/tests/xapian_tests/tests/xapian_query.py @@ -1,4 +1,4 @@ -# Copyright (C) 2009, 2010, 2011 David Sauve +# Copyright (C) 2009, 2010, 2011, 2012 David Sauve # Copyright (C) 2009, 2010 Trapeze import datetime @@ -18,40 +18,40 @@ class XapianSearchQueryTestCase(TestCase): def setUp(self): super(XapianSearchQueryTestCase, self).setUp() self.sq = connections['default'].get_query() - + def tearDown(self): if os.path.exists(settings.HAYSTACK_CONNECTIONS['default']['PATH']): shutil.rmtree(settings.HAYSTACK_CONNECTIONS['default']['PATH']) - + super(XapianSearchQueryTestCase, self).tearDown() - + def test_build_query_all(self): self.assertEqual(str(self.sq.build_query()), u'Xapian::Query()') - + def test_build_query_single_word(self): self.sq.add_filter(SQ(content='hello')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Zhello OR hello))') - + def test_build_query_single_word_not(self): self.sq.add_filter(~SQ(content='hello')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT (Zhello OR hello)))') - + def test_build_query_single_word_field_exact(self): self.sq.add_filter(SQ(foo='hello')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((ZXFOOhello OR XFOOhello))') - + def test_build_query_single_word_field_exact_not(self): self.sq.add_filter(~SQ(foo='hello')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT (ZXFOOhello OR XFOOhello)))') - + def test_build_query_boolean(self): self.sq.add_filter(SQ(content=True)) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Ztrue OR true))') - + def test_build_query_date(self): self.sq.add_filter(SQ(content=datetime.date(2009, 5, 8))) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Z20090508000000 OR 20090508000000))') - + def test_build_query_date_not(self): self.sq.add_filter(~SQ(content=datetime.date(2009, 5, 8))) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT (Z20090508000000 OR 20090508000000)))') @@ -59,7 +59,7 @@ class XapianSearchQueryTestCase(TestCase): def test_build_query_datetime(self): self.sq.add_filter(SQ(content=datetime.datetime(2009, 5, 8, 11, 28))) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Z20090508112800 OR 20090508112800))') - + def test_build_query_datetime_not(self): self.sq.add_filter(~SQ(content=datetime.datetime(2009, 5, 8, 11, 28))) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT (Z20090508112800 OR 20090508112800)))') @@ -67,68 +67,68 @@ class XapianSearchQueryTestCase(TestCase): def test_build_query_float(self): self.sq.add_filter(SQ(content=25.52)) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Z25.52 OR 25.52))') - + def test_build_query_multiple_words_and(self): self.sq.add_filter(SQ(content='hello')) self.sq.add_filter(SQ(content='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zhello OR hello) AND (Zworld OR world)))') - + def test_build_query_multiple_words_not(self): self.sq.add_filter(~SQ(content='hello')) self.sq.add_filter(~SQ(content='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((( AND_NOT (Zhello OR hello)) AND ( AND_NOT (Zworld OR world))))') - + def test_build_query_multiple_words_or(self): self.sq.add_filter(SQ(content='hello') | SQ(content='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Zhello OR hello OR Zworld OR world))') - + def test_build_query_multiple_words_or_not(self): self.sq.add_filter(~SQ(content='hello') | ~SQ(content='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((( AND_NOT (Zhello OR hello)) OR ( AND_NOT (Zworld OR world))))') - + def test_build_query_multiple_words_mixed(self): self.sq.add_filter(SQ(content='why') | SQ(content='hello')) self.sq.add_filter(~SQ(content='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why OR Zhello OR hello) AND ( AND_NOT (Zworld OR world))))') - + def test_build_query_multiple_word_field_exact(self): self.sq.add_filter(SQ(foo='hello')) self.sq.add_filter(SQ(bar='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((ZXFOOhello OR XFOOhello) AND (ZXBARworld OR XBARworld)))') - + def test_build_query_multiple_word_field_exact_not(self): self.sq.add_filter(~SQ(foo='hello')) self.sq.add_filter(~SQ(bar='world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((( AND_NOT (ZXFOOhello OR XFOOhello)) AND ( AND_NOT (ZXBARworld OR XBARworld))))') - + def test_build_query_phrase(self): self.sq.add_filter(SQ(content='hello world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((hello PHRASE 2 world))') - + def test_build_query_phrase_not(self): self.sq.add_filter(~SQ(content='hello world')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(( AND_NOT (hello PHRASE 2 world)))') - + def test_build_query_boost(self): self.sq.add_filter(SQ(content='hello')) self.sq.add_boost('world', 5) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zhello OR hello) AND_MAYBE 5 * (Zworld OR world)))') - + def test_build_query_in_filter_single_words(self): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(SQ(title__in=["Dune", "Jaws"])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND (ZXTITLEdune OR XTITLEdune OR ZXTITLEjaw OR XTITLEjaws)))') - + def test_build_query_not_in_filter_single_words(self): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(~SQ(title__in=["Dune", "Jaws"])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND ( AND_NOT (ZXTITLEdune OR XTITLEdune OR ZXTITLEjaw OR XTITLEjaws))))') - + def test_build_query_in_filter_multiple_words(self): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(SQ(title__in=["A Famous Paper", "An Infamous Article"])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND ((XTITLEa PHRASE 3 XTITLEfamous PHRASE 3 XTITLEpaper) OR (XTITLEan PHRASE 3 XTITLEinfamous PHRASE 3 XTITLEarticle))))') - + def test_build_query_in_filter_multiple_words_with_punctuation(self): self.sq.add_filter(SQ(title__in=["A Famous Paper", "An Infamous Article", "My Store Inc."])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((XTITLEa PHRASE 3 XTITLEfamous PHRASE 3 XTITLEpaper) OR (XTITLEan PHRASE 3 XTITLEinfamous PHRASE 3 XTITLEarticle) OR (XTITLEmy PHRASE 3 XTITLEstore PHRASE 3 XTITLEinc.)))') @@ -137,30 +137,30 @@ class XapianSearchQueryTestCase(TestCase): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(~SQ(title__in=["A Famous Paper", "An Infamous Article"])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND ( AND_NOT ((XTITLEa PHRASE 3 XTITLEfamous PHRASE 3 XTITLEpaper) OR (XTITLEan PHRASE 3 XTITLEinfamous PHRASE 3 XTITLEarticle)))))') - + def test_build_query_in_filter_datetime(self): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(SQ(pub_date__in=[datetime.datetime(2009, 7, 6, 1, 56, 21)])) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zwhi OR why) AND (ZXPUB_DATE20090706015621 OR XPUB_DATE20090706015621)))') - + def test_clean(self): self.assertEqual(self.sq.clean('hello world'), 'hello world') self.assertEqual(self.sq.clean('hello AND world'), 'hello AND world') self.assertEqual(self.sq.clean('hello AND OR NOT TO + - && || ! ( ) { } [ ] ^ " ~ * ? : \ world'), 'hello AND OR NOT TO + - && || ! ( ) { } [ ] ^ " ~ * ? : \ world') self.assertEqual(self.sq.clean('so please NOTe i am in a bAND and bORed'), 'so please NOTe i am in a bAND and bORed') - + def test_build_query_with_models(self): self.sq.add_filter(SQ(content='hello')) self.sq.add_model(MockModel) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query(((Zhello OR hello) AND 0 * XCONTENTTYPEcore.mockmodel))') - + self.sq.add_model(AnotherMockModel) self.assertTrue(str(self.sq.build_query()) in u'Xapian::Query(((Zhello OR hello) AND (0 * XCONTENTTYPEcore.anothermockmodel OR 0 * XCONTENTTYPEcore.mockmodel)))' or u'Xapian::Query(((Zhello OR hello) AND (0 * XCONTENTTYPEcore.mockmodel OR 0 * XCONTENTTYPEcore.anothermockmodel)))') def test_build_query_with_punctuation(self): self.sq.add_filter(SQ(content='http://www.example.com')) self.assertEqual(str(self.sq.build_query()), u'Xapian::Query((Zhttp://www.example.com OR http://www.example.com))') - + def test_in_filter_values_list(self): self.sq.add_filter(SQ(content='why')) self.sq.add_filter(SQ(title__in=MockModel.objects.values_list('id', flat=True)))