Args+kwargs with redis 3

.gitignore

@@ -66,3 +66,7 @@ target/
 
 # SQLite
 *.sqlite3
+
+# Pipenv
+Pipfile
+Pipfile.lock

MANIFEST.in

@@ -1,4 +1,4 @@
 include MANIFEST.in
 include README.md
-recursive-include scheduler *.py
+recursive-include scheduler *.py *.js
 exclude testproject19

README.md

@@ -8,8 +8,8 @@ Currently, when you pip install Django RQ Scheduler the following packages are a
 
 * django >= 1.9
 * django-model-utils >= 2.4
-* django-rq >= 0.9.3 (Django RQ requires RQ >= 0.5.5)
-* rq-scheduler >= 0.6.0
+* django-rq >= 2.0 (Django RQ requires RQ >= 1.0 due to changes in redis >= 3)
+* rq-scheduler >= 0.9.0
 * pytz >= 2015.7
 * croniter >= 0.3.24
 
@@ -45,6 +45,10 @@ pip install django-rq-scheduler
 
 
 	```
+    If you also wish to run the underpinning **RQ Scheduler** at an interval different from its default of 
+    once every 60 seconds you can do so by setting `DJANGO_RQ_SCHEDULER_INTERVAL` to the new preferred interval. 
+    This is important if you want a job to either run multiple times a minute 
+    or to schedule a job more precisely than within a 60 second window.
 
 2. Configure Django RQ. See https://github.com/ui/django-rq#installation
 
@@ -104,6 +108,8 @@ def count():
 6. Enter the time the first job is to be executed in the **Scheduled time** field. Side Note: Enter the date via the browser's local timezone, the time will automatically convert UTC.
 
 7. Enter an **Interval**, and choose the **Interval unit**. This will calculate the time before the function is called again.
+    * The **result TTL** must be either indefinite `-1`, unset,  or greater than this interval.
+    * The **Interval** must be a multiple of the scheduler's interval. With a default config this interval is 60 seconds and is only a consideration when using `seconds` as the **Interval Unit**. If a shorter interval is needed **rq-scheduler**'s interval can be changed by setting `DJANGO_RQ_SCHEDULER_INTERVAL` to something other than `60`; it's advised to set it to a divisor of `60`.
 
 8. In the **Repeat** field, enter the number of time the job is to be ran. Leaving the field empty, means the job will be scheduled to run forever.
 

scheduler/__init__.py

@@ -1,3 +1,3 @@
-__version__ = '1.1.3'
+__version__ = '1.2.0'
 
 default_app_config = 'scheduler.apps.SchedulerConfig'

scheduler/admin.py

@@ -1,52 +1,140 @@
 from __future__ import unicode_literals
 
 from django.conf import settings
-from django.contrib import admin
+from django.contrib import admin, messages
+from django.contrib.contenttypes.admin import GenericStackedInline
+from django.templatetags.tz import utc
+from django.utils.timezone import now
 from django.utils.translation import ugettext_lazy as _
 
-from scheduler.models import CronJob, RepeatableJob, ScheduledJob
-
+from scheduler.models import CronJob, JobArg, JobKwarg, RepeatableJob, ScheduledJob
 
 QUEUES = [(key, key) for key in settings.RQ_QUEUES.keys()]
 
 
-class QueueMixin(object):
-    actions = ['delete_model']
+class HiddenMixin(object):
+    # pass
+    class Media:
+        js = ['admin/js/jquery.init.js', 'scheduler/js/base.js']
+
+
+class JobArgInline(HiddenMixin, GenericStackedInline):
+    model = JobArg
+    extra = 0
+    fieldsets = (
+        (None, {
+            'fields': ('arg_type', 'str_val', 'int_val', 'bool_val', 'datetime_val',),
+        }),
+    )
+
+
+class JobKwargInline(HiddenMixin, GenericStackedInline):
+    model = JobKwarg
+    extra = 0
+    fieldsets = (
+        (None, {
+            'fields': ('key', 'arg_type', 'str_val', 'int_val', 'bool_val', 'datetime_val',),
+        }),
+    )
+
+
+class JobAdmin(admin.ModelAdmin):
+    actions = ['delete_model', 'disable_selected', 'enable_selected', 'run_job_now']
+    inlines = [JobArgInline, JobKwargInline]
+    list_filter = ('enabled', )
+    list_display = ('enabled', 'name', 'job_id', 'function_string', 'is_scheduled',)
+    list_display_links = ('name',)
+    readonly_fields = ('job_id', )
+    fieldsets = (
+        (None, {
+            'fields': ('name', 'callable', 'enabled',),
+        }),
+        (_('RQ Settings'), {
+            'fields': ('queue', 'job_id',),
+        }),
+    )
 
     def get_actions(self, request):
-        actions = super(QueueMixin, self).get_actions(request)
-        del actions['delete_selected']
+        actions = super(JobAdmin, self).get_actions(request)
+        actions.pop('delete_selected', None)
         return actions
 
     def get_form(self, request, obj=None, **kwargs):
         queue_field = self.model._meta.get_field('queue')
         queue_field.choices = QUEUES
-        return super(QueueMixin, self).get_form(request, obj, **kwargs)
+        return super(JobAdmin, self).get_form(request, obj, **kwargs)
 
-    def delete_model(self, request, obj):
-        if hasattr(obj, 'all'):
-            for o in obj.all():
-                o.delete()
-        else:
+    def delete_model(self, request, queryset):
+        rows_deleted = 0
+        for obj in queryset.all().iterator():
             obj.delete()
+            rows_deleted += 1
+        if rows_deleted == 1:
+            message_bit = "1 job was"
+        else:
+            message_bit = "%s jobs were" % rows_deleted
+
+        level = messages.WARNING if not rows_deleted else messages.INFO
+        self.message_user(request, "%s successfully deleted." % message_bit, level=level)
     delete_model.short_description = _("Delete selected %(verbose_name_plural)s")
+    delete_model.allowed_permissions = ('delete',)
+
+    def disable_selected(self, request, queryset):
+        rows_updated = 0
+        for obj in queryset.filter(enabled=True).iterator():
+            obj.enabled = False
+            obj.save()
+            rows_updated += 1
+        if rows_updated == 1:
+            message_bit = "1 job was"
+        else:
+            message_bit = "%s jobs were" % rows_updated
+
+        level = messages.WARNING if not rows_updated else messages.INFO
+        self.message_user(request, "%s successfully disabled." % message_bit, level=level)
+    disable_selected.short_description = _("Disable selected %(verbose_name_plural)s")
+    disable_selected.allowed_permissions = ('change',)
+
+    def enable_selected(self, request, queryset):
+        rows_updated = 0
+        for obj in queryset.filter(enabled=False).iterator():
+            obj.enabled = True
+            obj.save()
+            rows_updated += 1
+        if rows_updated == 1:
+            message_bit = "1 job was"
+        else:
+            message_bit = "%s jobs were" % rows_updated
+        level = messages.WARNING if not rows_updated else messages.INFO
+        self.message_user(request, "%s successfully enabled." % message_bit, level=level)
+    enable_selected.short_description = _("Enable selected %(verbose_name_plural)s")
+    enable_selected.allowed_permissions = ('change',)
+
+    def run_job_now(self, request, queryset):
+        job_names = []
+        for obj in queryset:
+            kwargs = obj.parse_kwargs()
+            if obj.timeout:
+                kwargs['timeout'] = obj.timeout
+            if hasattr(obj, 'result_ttl') and obj.result_ttl is not None:
+                kwargs['job_result_ttl'] = obj.result_ttl
+            obj.scheduler().enqueue_at(
+                utc(now()),
+                obj.callable_func(),
+                *obj.parse_args(),
+                **kwargs
+            )
+            job_names.append(obj.name)
+        self.message_user(request, "The following jobs have been run: %s" % ', '.join(job_names))
+    run_job_now.short_description = "Run now"
+    run_job_now.allowed_permissions = ('change',)
 
 
 @admin.register(ScheduledJob)
-class ScheduledJobAdmin(QueueMixin, admin.ModelAdmin):
-    list_display = (
-        'name', 'job_id', 'is_scheduled', 'scheduled_time', 'enabled')
-    list_filter = ('enabled', )
-    list_editable = ('enabled', )
+class ScheduledJobAdmin(JobAdmin):
+    list_display = JobAdmin.list_display + ('scheduled_time',)
 
-    readonly_fields = ('job_id', )
-    fieldsets = (
-        (None, {
-            'fields': ('name', 'callable', 'enabled', ),
-        }),
-        (_('RQ Settings'), {
-            'fields': ('queue', 'job_id', ),
-        }),
+    fieldsets = JobAdmin.fieldsets + (
         (_('Scheduling'), {
             'fields': (
                 'scheduled_time',
@@ -58,48 +146,27 @@ class ScheduledJobAdmin(QueueMixin, admin.ModelAdmin):
 
 
 @admin.register(RepeatableJob)
-class RepeatableJobAdmin(QueueMixin, admin.ModelAdmin):
-    list_display = (
-        'name', 'job_id', 'is_scheduled', 'scheduled_time', 'interval_display',
-        'enabled')
-    list_filter = ('enabled', )
-    list_editable = ('enabled', )
+class RepeatableJobAdmin(JobAdmin):
+    list_display = JobAdmin.list_display + ('scheduled_time', 'interval_display')
 
-    readonly_fields = ('job_id', )
-    fieldsets = (
-        (None, {
-            'fields': ('name', 'callable', 'enabled', ),
-        }),
-        (_('RQ Settings'), {
-            'fields': ('queue', 'job_id', ),
-        }),
+    fieldsets = JobAdmin.fieldsets + (
         (_('Scheduling'), {
             'fields': (
                 'scheduled_time',
                 ('interval', 'interval_unit', ),
                 'repeat',
                 'timeout',
-                'result_ttl'
+                'result_ttl',
             ),
         }),
     )
 
 
 @admin.register(CronJob)
-class CronJobAdmin(QueueMixin, admin.ModelAdmin):
-    list_display = (
-        'name', 'job_id', 'is_scheduled', 'cron_string', 'enabled')
-    list_filter = ('enabled', )
-    list_editable = ('enabled', )
+class CronJobAdmin(JobAdmin):
+    list_display = JobAdmin.list_display + ('cron_string',)
 
-    readonly_fields = ('job_id', )
-    fieldsets = (
-        (None, {
-            'fields': ('name', 'callable', 'enabled', ),
-        }),
-        (_('RQ Settings'), {
-            'fields': ('queue', 'job_id', ),
-        }),
+    fieldsets = JobAdmin.fieldsets + (
         (_('Scheduling'), {
             'fields': (
                 'cron_string',

scheduler/migrations/0006_seconds_interval_units.py

@@ -0,0 +1,24 @@
+# Generated by Django 2.1.2 on 2018-10-10 01:02
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('scheduler', '0005_added_result_ttl'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='cronjob',
+            name='cron_string',
+            field=models.CharField(help_text='Define the schedule in a crontab like syntax. Times are in UTC.',
+                                   max_length=64, verbose_name='cron string'),
+        ),
+        migrations.AlterField(
+            model_name='repeatablejob',
+            name='interval_unit',
+            field=models.CharField(choices=[('seconds', 'seconds'), ('minutes', 'minutes'), ('hours', 'hours'), ('days', 'days'), ('weeks', 'weeks')], default='hours', max_length=12, verbose_name='interval unit'),
+        ),
+    ]

scheduler/migrations/0007_added_args_kwargs.py

@@ -0,0 +1,50 @@
+# Generated by Django 2.2.2 on 2019-06-03 16:09
+
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('contenttypes', '0002_remove_content_type_name'),
+        ('scheduler', '0006_seconds_interval_units'),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name='JobKwarg',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('arg_type', models.CharField(choices=[('str_val', 'string'), ('int_val', 'int'), ('bool_val', 'boolean'), ('datetime_val', 'Datetime')], default='str_val', max_length=12, verbose_name='Argument Type')),
+                ('str_val', models.CharField(blank=True, max_length=255, verbose_name='String Value')),
+                ('int_val', models.IntegerField(blank=True, null=True, verbose_name='Int Value')),
+                ('bool_val', models.BooleanField(default=False, verbose_name='Boolean Value')),
+                ('datetime_val', models.DateTimeField(blank=True, null=True, verbose_name='Datetime Value')),
+                ('object_id', models.PositiveIntegerField()),
+                ('key', models.CharField(max_length=255)),
+                ('content_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType')),
+            ],
+            options={
+                'ordering': ['id'],
+                'abstract': False,
+            },
+        ),
+        migrations.CreateModel(
+            name='JobArg',
+            fields=[
+                ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')),
+                ('arg_type', models.CharField(choices=[('str_val', 'string'), ('int_val', 'int'), ('bool_val', 'boolean'), ('datetime_val', 'Datetime')], default='str_val', max_length=12, verbose_name='Argument Type')),
+                ('str_val', models.CharField(blank=True, max_length=255, verbose_name='String Value')),
+                ('int_val', models.IntegerField(blank=True, null=True, verbose_name='Int Value')),
+                ('bool_val', models.BooleanField(default=False, verbose_name='Boolean Value')),
+                ('datetime_val', models.DateTimeField(blank=True, null=True, verbose_name='Datetime Value')),
+                ('object_id', models.PositiveIntegerField()),
+                ('content_type', models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, to='contenttypes.ContentType')),
+            ],
+            options={
+                'ordering': ['id'],
+                'abstract': False,
+            },
+        ),
+    ]