Deprecated get_queryset & fixed how indexing happens. Thanks to Craig de Stigter & others for the report!

Author: toastdriven

docs/migration_from_1_to_2.rst

@@ -169,8 +169,8 @@ set the ``HAYSTACK_DOCUMENT_FIELD`` setting. For example::
     HAYSTACK_DOCUMENT_FIELD = 'pink_polka_dot'
 
 Finally, the ``index_queryset`` method should supplant the ``get_queryset``
-method. This was present in the Haystack 1.2.X series & ``get_queryset`` will
-continue to work for backward-compatibility.
+method. This was present in the Haystack 1.2.X series (with a deprecation warning
+in 1.2.4+) but has been removed in Haystack v2.
 
 Finally, if you were unregistering other indexes before, you should make use of
 the new ``HAYSTACK_EXCLUDED_INDEXES`` setting. It should be a list of strings

docs/searchindex_api.rst

@@ -380,13 +380,6 @@ Get the default QuerySet to index when doing a full update.
 
 Subclasses can override this method to avoid indexing certain objects.
 
-``get_queryset``
-----------------
-
-.. method:: SearchIndex.get_queryset(self)
-
-Alias of ``SearchIndex.index_queryset`` for backwards compatibility.
-
 ``read_queryset``
 -----------------
 

haystack/indexes.py

@@ -123,12 +123,6 @@ def index_queryset(self):
         """
         return self.get_model()._default_manager.all()
 
-    def get_queryset(self):
-        """
-        Alias of index_queryset for backwards compatibility.
-        """
-        return self.index_queryset()
-    
     def read_queryset(self):
         """
         Get the default QuerySet for read actions.

haystack/management/commands/update_index.py

@@ -1,5 +1,6 @@
 import datetime
 import os
+import warnings
 from optparse import make_option
 from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
@@ -58,12 +59,20 @@ def build_queryset(index, model, age=DEFAULT_AGE, verbosity=1):
             if verbosity >= 2:
                 print "No updated date field found for '%s' - not restricting by age." % model.__name__
 
-    if not hasattr(index.index_queryset(), 'filter'):
-        raise ImproperlyConfigured("The '%r' class must return a 'QuerySet' in the 'get_queryset' method." % index)
+    index_qs = None
+
+    if hasattr(index, 'get_queryset'):
+        warnings.warn("'SearchIndex.get_queryset' was deprecated in Haystack v2. Please rename the method 'index_queryset'.")
+        index_qs = index.get_queryset()
+    else:
+        index_qs = index.index_queryset()
+
+    if not hasattr(index_qs, 'filter'):
+        raise ImproperlyConfigured("The '%r' class must return a 'QuerySet' in the 'index_queryset' method." % index)
 
     # `.select_related()` seems like a good idea here but can fail on
     # nullable `ForeignKey` as well as what seems like other cases.
-    return index.index_queryset().filter(**extra_lookup_kwargs).order_by(model._meta.pk.name)
+    return index_qs.filter(**extra_lookup_kwargs).order_by(model._meta.pk.name)
 
 
 def do_update(backend, index, qs, start, end, total, verbosity=1):

tests/core/tests/indexes.py

@@ -196,9 +196,6 @@ def test_proper_fields(self):
     def test_index_queryset(self):
         self.assertEqual(len(self.cmi.index_queryset()), 3)
 
-    def test_get_queryset(self):
-        self.assertEqual(len(self.cmi.get_queryset()), 3)
-    
     def test_read_queryset(self):
         self.assertEqual(len(self.cmi.read_queryset()), 2)