Initial commit

Author: mback2k

Diff for: .gitattributes

@@ -0,0 +1,9 @@
+# Set default behaviour, in case users don't have core.autocrlf set.
+* text=auto
+
+# Explicitly declare text files we want to always be normalized and converted
+# to native line endings on checkout.
+.gitignore text
+.gitattributes text
+*.py text
+*.md text

Diff for: .gitignore

@@ -0,0 +1 @@
+*.pyc

Diff for: COPYING

@@ -0,0 +1,19 @@
+Copyright (c) 2014 Marc Hoersken <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

Diff for: README.md

@@ -0,0 +1,29 @@
+[Django-Celery-Model](https://github.com/mback2k/django-celery-model) is an
+extension to [Django-Celery](https://github.com/celery/django-celery)
+which adds supports for tracking tasks aligned to Django model instances.
+
+Installation
+------------
+You can install the latest version from GitHub manually:
+
+    git clone https://github.com/mback2k/django-celery-model.git
+    cd django-celery-model
+    python setup.py install
+
+or via pip:
+
+    pip install https://github.com/mback2k/django-celery-model/zipball/master
+
+Configuration
+-------------
+Add the package to your `INSTALLED_APPS`:
+
+    INSTALLED_APPS += (
+        'djcelery',
+        'djcelery_model',
+    )
+
+License
+-------
+* Released under MIT License
+* Copyright (c) 2014 Marc Hoersken <[email protected]>

Diff for: djcelery_model/__init__.py

@@ -0,0 +1,24 @@
+"""
+django-celery-model is an extension to Celery and django-celery that supports tasks aligned to Django models.
+"""
+
+__version_info__ = {
+    'major': 0,
+    'minor': 0,
+    'micro': 1,
+    'releaselevel': 'dev',
+}
+
+def get_version():
+    """
+    Return the formatted version information
+    """
+    vers = ["%(major)i.%(minor)i" % __version_info__, ]
+
+    if __version_info__['micro']:
+        vers.append(".%(micro)i" % __version_info__)
+    if __version_info__['releaselevel'] != 'final':
+        vers.append('%(releaselevel)s' % __version_info__)
+    return ''.join(vers)
+
+__version__ = get_version()

Diff for: djcelery_model/models.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+from django.db import models
+from django.contrib.contenttypes import generic
+from django.contrib.contenttypes.models import ContentType
+from celery.result import BaseAsyncResult
+from celery.utils import uuid
+
+class ModelTaskMeta(models.Model):
+    content_type = models.ForeignKey(ContentType)
+    object_id = models.PositiveIntegerField()
+    content_object = generic.GenericForeignKey()
+    task_id = models.CharField(max_length=255, unique=True)
+
+    def __unicode__(self):
+        return self.task_id
+
+class ModelAsyncResult(BaseAsyncResult):
+    def forget(self):
+        ModelTaskMeta.objects.filter(task_id=self.id).delete()
+        return super(ModelAsyncResult, self).forget()
+
+class TaskMixin(object):
+    class Meta:
+        abstract = True
+
+    @property
+    def tasks(self):
+        content_type = ContentType.objects.get_for_model(self)
+        queryset = ModelTaskMeta.objects.filter(content_type=content_type)
+        return queryset.filter(object_id=self.pk)
+
+    def apply_async(self, task, *args, **kwargs):
+        if 'task_id' in kwargs:
+            task_id = kwargs['task_id']
+        else:
+            task_id = kwargs['task_id'] = uuid()
+        try:
+            taskmeta = ModelTaskMeta.objects.get(task_id=task_id)
+            taskmeta.content_object = self
+            forget_if_ready(BaseAsyncResult(task_id))
+        except ModelTaskMeta.DoesNotExist:
+            taskmeta = ModelTaskMeta(task_id=task_id, content_object=self)
+        taskmeta.save()
+        return task.apply_async(*args, **kwargs)
+
+    def get_task_results(self):
+        return map(lambda task_id: ModelAsyncResult(task_id),
+                   self.tasks.values_list('task_id', flat=True))
+
+    def get_task_result(self, task_id):
+        if self.tasks.filter(task_id=task_id).exists():
+            return ModelAsyncResult(task_id)
+        return BaseAsyncResult(task_id)
+
+    def clear_task_results(self):
+        map(forget_if_ready, self.get_task_results())
+
+    def clear_task_result(self, task_id):
+        forget_if_ready(self.get_task_result(task_id))
+
+    @property
+    def has_running_task(self):
+        return len(filter(lambda x: not x.ready(), self.get_task_results())) > 0
+
+def forget_if_ready(async_result):
+    if async_result and async_result.ready():
+        async_result.forget()

Diff for: setup.py

@@ -0,0 +1,34 @@
+from setuptools import setup, find_packages
+import os
+
+def read_file(filename):
+    """Read a file into a string"""
+    path = os.path.abspath(os.path.dirname(__file__))
+    filepath = os.path.join(path, filename)
+    try:
+        return open(filepath).read()
+    except IOError:
+        return ''
+
+setup(
+    name='django-celery-model',
+    version=__import__('djcelery_model').__version__,
+    author='Marc Hoersken',
+    author_email='[email protected]',
+    packages=find_packages(),
+    include_package_data=True,
+    url='https://github.com/mback2k/django-celery-model',
+    license='MIT',
+    description=u' '.join(__import__('djcelery_model').__doc__.splitlines()).strip(),
+    install_requires=['Celery>=3.1.10'],
+    classifiers=[
+        'Topic :: Internet :: WWW/HTTP :: Dynamic Content',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: MIT License',
+        'Programming Language :: Python',
+        'Topic :: Software Development :: Libraries :: Python Modules',
+        'Development Status :: 4 - Beta',
+        'Operating System :: OS Independent',
+    ],
+    long_description=read_file('README.md'),
+)