Merge branch 'release/0.4'

Author: jezdez

.gitignore

@@ -3,4 +3,6 @@
 tests/whoosh_index
 *.egg
 *.egg-info
-.tox
+.tox
+.coverage
+docs/_build

AUTHORS

@@ -1 +1,2 @@
 Jannis Leidel <jannis@leidel.info>
+Daniel Lindsley

MANIFEST.in

@@ -1,3 +1,5 @@
 include README.rst
 include AUTHORS
-recursive-include tests *
+include tox.ini
+recursive-include tests *
+recursive-include docs *

README.rst

@@ -10,7 +10,7 @@ Requirements
 
 * Django 1.2+
 * Haystack_ `1.2.X`_ *or* `2.0.X`_
-* Celery_ 1.X
+* Celery_ 2.X
 
 You also need to install your choice of one of the supported search engines
 for Haystack and one of the supported backends for Celery.
@@ -26,6 +26,16 @@ Use your favorite Python package manager to install the app from PyPI, e.g.::
 
  pip install celery-haystack
 
+By default a few dependencies will automatically be installed:
+
+- django-appconf_ -- An app to gracefully handle application settings.
+
+- versiontools_ -- A library to help staying compatible to `PEP 386`_.
+
+.. _django-appconf: http://pypi.python.org/pypi/django-appconf
+.. _versiontools: http://pypi.python.org/pypi/versiontools
+.. _`PEP 386`: http://www.python.org/dev/peps/pep-0386/
+
 Setup
 -----
 
@@ -35,53 +45,6 @@ Setup
  ``haystack.indexes.Indexable``).
 3. Ensure your Celery instance is running.
 
-Changelog
----------
-
-0.3.1 (2011-08-22)
-^^^^^^^^^^^^^^^^^^
-
-* Minor bugfix in new appconf support code.
-
-0.3 (2011-08-22)
-^^^^^^^^^^^^^^^^
-
-* Moved configuration defaults handling to django-appconf_.
-
-* Fixed issue that occured when retrying a task.
-
-.. _django-appconf: http://pypi.python.org/pypi/django-appconf
-
-0.2.1 (2011-08-05)
-^^^^^^^^^^^^^^^^^^
-
-* Fixed typo in exception message handling.
-
-0.2 (2011-08-04)
-^^^^^^^^^^^^^^^^
-
-* Added support for Haystack 1.2.X.
-
-* Properly stop indexing if instance couldn't be found.
-
-* Forced Celery task config values to be of the correct type.
-
-0.1.2 (2011-07-29) and 0.1.3 (2011-08-01)
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-* Removed stale print statement.
-
-0.1.1 (2011-07-29)
-^^^^^^^^^^^^^^^^^^
-
-* Fixed packaging issue (added manifest template).
-
-
-0.1 (2011-07-29)
-^^^^^^^^^^^^^^^^
-
-* Initial release.
-
 Thanks
 ------
 
@@ -92,3 +55,11 @@ queues_ library by Matt Croyden.
 .. _queued_search: https://github.com/toastdriven/queued_search/
 .. _Celery: http://celeryproject.org/
 .. _queues: http://code.google.com/p/queues/
+
+Issues
+------
+
+Please use the `Github issue tracker`_ for any bug reports or feature
+requests.
+
+.. _`Github issue tracker`: https://github.com/ennio/celery-haystack/issues

celery_haystack/__init__.py

@@ -1,2 +1,2 @@
 # following PEP 386, versiontools will pick it up
-__version__ = (0, 3, 1, "final", 0)
+__version__ = (0, 4, 0, "final", 0)

celery_haystack/conf.py

@@ -0,0 +1,29 @@
+from django.conf import settings
+from haystack import constants
+from appconf import AppConf
+
+
+class CeleryHaystack(AppConf):
+ DEFAULT_ALIAS = None
+ RETRY_DELAY = 5 * 60
+ MAX_RETRIES = 1
+ DEFAULT_TASK = 'celery_haystack.tasks.CeleryHaystackSignalHandler'
+
+ COMMAND_BATCH_SIZE = None
+ COMMAND_AGE = None
+ COMMAND_REMOVE = False
+ COMMAND_WORKERS = 0
+ COMMAND_APPS = []
+ COMMAND_VERBOSITY = 1
+
+ def configure_default_alias(self, value):
+ return value or getattr(constants, 'DEFAULT_ALIAS', None)
+
+ def configure(self):
+ data = {}
+ for name, value in self.configured_data.items():
+ if name in ('RETRY_DELAY', 'MAX_RETRIES',
+ 'COMMAND_WORKERS', 'COMMAND_VERBOSITY'):
+ value = int(value)
+ data[name] = value
+ return data

celery_haystack/indexes.py

@@ -1,38 +1,10 @@
 from django.db.models import signals
 
-from haystack import constants, indexes
+from haystack import indexes
 from haystack.utils import get_identifier
 
 from celery_haystack.utils import get_update_task
 
-from appconf import AppConf
-
-
-class CeleryHaystack(AppConf):
- DEFAULT_ALIAS = None
- RETRY_DELAY = 5 * 60
- MAX_RETRIES = 1
- DEFAULT_TASK = 'celery_haystack.tasks.CeleryHaystackSignalHandler'
-
- COMMAND_BATCH_SIZE = None
- COMMAND_AGE = None
- COMMAND_REMOVE = False
- COMMAND_WORKERS = 0
- COMMAND_APPS = []
- COMMAND_VERBOSITY = 1
-
- def configure_default_alias(self, value):
- return value or getattr(constants, 'DEFAULT_ALIAS', None)
-
- def configure(self):
- data = {}
- for name, value in self.configured_data.items():
- if name in ('RETRY_DELAY', 'MAX_RETRIES',
- 'COMMAND_WORKERS', 'COMMAND_VERBOSITY'):
- value = int(value)
- data[name] = value
- return data
-
 
 class CelerySearchIndex(indexes.SearchIndex):
  """

celery_haystack/tasks.py

@@ -1,9 +1,9 @@
-from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
 from django.core.management import call_command
 from django.db.models.loading import get_model
 
 from celery.task import Task
+from celery_haystack.conf import settings
 
 try:
  from haystack import connections
@@ -88,10 +88,8 @@ def get_index(self, model_class, **kwargs):
  logger.error("Couldn't find a SearchIndex for %s." % model_class)
  return None
 
- def get_handler_options(self, instance, **kwargs):
- options = {
- 'instance': instance,
- }
+ def get_handler_options(self, **kwargs):
+ options = {}
  if legacy:
  options['using'] = self.using
  return options
@@ -111,31 +109,42 @@ def run(self, action, identifier, **kwargs):
 
  # Then get the model class for the object path
  model_class = self.get_model_class(object_path, **kwargs)
- # and the instance of the model class with the pk
- instance = self.get_instance(model_class, pk, **kwargs)
- if instance is None:
- logger.debug("Didn't update index for '%s'" % identifier)
+ current_index = self.get_index(model_class, **kwargs)
+
+ if action == 'delete':
+ # If the object is gone, we'll use just the identifier against the
+ # index.
+ try:
+ handler_options = self.get_handler_options(**kwargs)
+ current_index.remove_object(identifier, **handler_options)
+ except Exception, exc:
+ logger.error(exc)
+ self.retry([action, identifier], kwargs, exc=exc)
+ else:
+ logger.debug("Deleted '%s' from index" % identifier)
  return
 
- # Call the appropriate handler of the current index and
- # handle exception if neccessary
- logger.debug("Indexing '%s'." % instance)
- try:
- current_index = self.get_index(model_class, **kwargs)
- handlers = {
- 'update': current_index.update_object,
- 'delete': current_index.remove_object,
- }
- handler_options = self.get_handler_options(instance, **kwargs)
- handlers[action](**handler_options)
- except KeyError, exc:
+ elif action == 'update':
+ # and the instance of the model class with the pk
+ instance = self.get_instance(model_class, pk, **kwargs)
+ if instance is None:
+ logger.debug("Didn't update index for '%s'" % identifier)
+ return
+
+ # Call the appropriate handler of the current index and
+ # handle exception if neccessary
+ logger.debug("Indexing '%s'." % instance)
+ try:
+ handler_options = self.get_handler_options(**kwargs)
+ current_index.update_object(instance, **handler_options)
+ except Exception, exc:
+ logger.error(exc)
+ self.retry([action, identifier], kwargs, exc=exc)
+ else:
+ logger.debug("Updated index with '%s'" % instance)
+ else:
  logger.error("Unrecognized action '%s'. Moving on..." % action)
  self.retry([action, identifier], kwargs, exc=exc)
- except Exception, exc:
- logger.error(exc)
- self.retry([action, identifier], kwargs, exc=exc)
- else:
- logger.debug("Updated index with '%s'" % instance)
 
 
 class CeleryHaystackUpdateIndex(Task):

celery_haystack/utils.py

@@ -1,10 +1,8 @@
-import sys
-
-from django.conf import settings
 from django.core.exceptions import ImproperlyConfigured
-from django.utils.functional import SimpleLazyObject
 from django.utils.importlib import import_module
 
+from celery_haystack.conf import settings
+
 
 def get_update_task(task_path=None):
  import_path = task_path or settings.CELERY_HAYSTACK_DEFAULT_TASK