django-tasks-scheduler 1.0.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (71) hide show
  1. django_tasks_scheduler-1.0.0/LICENSE +21 -0
  2. django_tasks_scheduler-1.0.0/PKG-INFO +57 -0
  3. django_tasks_scheduler-1.0.0/README.md +16 -0
  4. django_tasks_scheduler-1.0.0/pyproject.toml +67 -0
  5. django_tasks_scheduler-1.0.0/scheduler/__init__.py +5 -0
  6. django_tasks_scheduler-1.0.0/scheduler/admin/__init__.py +2 -0
  7. django_tasks_scheduler-1.0.0/scheduler/admin/job.py +146 -0
  8. django_tasks_scheduler-1.0.0/scheduler/admin/redis_models.py +44 -0
  9. django_tasks_scheduler-1.0.0/scheduler/apps.py +11 -0
  10. django_tasks_scheduler-1.0.0/scheduler/decorators.py +43 -0
  11. django_tasks_scheduler-1.0.0/scheduler/management/__init__.py +0 -0
  12. django_tasks_scheduler-1.0.0/scheduler/management/commands/__init__.py +0 -0
  13. django_tasks_scheduler-1.0.0/scheduler/management/commands/delete_failed_executions.py +31 -0
  14. django_tasks_scheduler-1.0.0/scheduler/management/commands/export.py +64 -0
  15. django_tasks_scheduler-1.0.0/scheduler/management/commands/import.py +109 -0
  16. django_tasks_scheduler-1.0.0/scheduler/management/commands/rqstats.py +107 -0
  17. django_tasks_scheduler-1.0.0/scheduler/management/commands/rqworker.py +85 -0
  18. django_tasks_scheduler-1.0.0/scheduler/management/commands/run_job.py +37 -0
  19. django_tasks_scheduler-1.0.0/scheduler/migrations/0001_initial_squashed_0005_added_result_ttl.py +98 -0
  20. django_tasks_scheduler-1.0.0/scheduler/migrations/0002_alter_cronjob_id_alter_repeatablejob_id_and_more.py +27 -0
  21. django_tasks_scheduler-1.0.0/scheduler/migrations/0003_auto_20220329_2107.py +85 -0
  22. django_tasks_scheduler-1.0.0/scheduler/migrations/0004_cronjob_at_front_repeatablejob_at_front_and_more.py +27 -0
  23. django_tasks_scheduler-1.0.0/scheduler/migrations/0005_alter_cronjob_at_front_alter_repeatablejob_at_front_and_more.py +27 -0
  24. django_tasks_scheduler-1.0.0/scheduler/migrations/0006_auto_20230118_1640.py +25 -0
  25. django_tasks_scheduler-1.0.0/scheduler/migrations/0007_add_result_ttl.py +34 -0
  26. django_tasks_scheduler-1.0.0/scheduler/migrations/0008_rename_str_val_jobarg_val_and_more.py +60 -0
  27. django_tasks_scheduler-1.0.0/scheduler/migrations/0009_alter_jobarg_arg_type_alter_jobarg_val_and_more.py +36 -0
  28. django_tasks_scheduler-1.0.0/scheduler/migrations/0010_queue.py +23 -0
  29. django_tasks_scheduler-1.0.0/scheduler/migrations/0011_worker_alter_queue_options_alter_cronjob_at_front_and_more.py +149 -0
  30. django_tasks_scheduler-1.0.0/scheduler/migrations/0012_alter_cronjob_name_alter_repeatablejob_name_and_more.py +27 -0
  31. django_tasks_scheduler-1.0.0/scheduler/migrations/0013_alter_cronjob_queue_alter_repeatablejob_queue_and_more.py +43 -0
  32. django_tasks_scheduler-1.0.0/scheduler/migrations/__init__.py +0 -0
  33. django_tasks_scheduler-1.0.0/scheduler/models/__init__.py +3 -0
  34. django_tasks_scheduler-1.0.0/scheduler/models/args.py +96 -0
  35. django_tasks_scheduler-1.0.0/scheduler/models/queue.py +12 -0
  36. django_tasks_scheduler-1.0.0/scheduler/models/scheduled_job.py +411 -0
  37. django_tasks_scheduler-1.0.0/scheduler/models/worker.py +12 -0
  38. django_tasks_scheduler-1.0.0/scheduler/py.typed +0 -0
  39. django_tasks_scheduler-1.0.0/scheduler/queues.py +158 -0
  40. django_tasks_scheduler-1.0.0/scheduler/rq_classes.py +253 -0
  41. django_tasks_scheduler-1.0.0/scheduler/settings.py +38 -0
  42. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/change_form.html +6 -0
  43. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/change_list.html +6 -0
  44. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/confirm_action.html +42 -0
  45. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/job_detail.html +217 -0
  46. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/jobs-list.partial.html +68 -0
  47. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/jobs.html +140 -0
  48. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/queue_workers.html +31 -0
  49. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/scheduler_base.html +23 -0
  50. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/single_job_action.html +40 -0
  51. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/stats.html +110 -0
  52. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/worker_details.html +91 -0
  53. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/workers-list.partial.html +56 -0
  54. django_tasks_scheduler-1.0.0/scheduler/templates/admin/scheduler/workers.html +33 -0
  55. django_tasks_scheduler-1.0.0/scheduler/templatetags/__init__.py +0 -0
  56. django_tasks_scheduler-1.0.0/scheduler/templatetags/scheduler_tags.py +69 -0
  57. django_tasks_scheduler-1.0.0/scheduler/tests/__init__.py +0 -0
  58. django_tasks_scheduler-1.0.0/scheduler/tests/jobs.py +31 -0
  59. django_tasks_scheduler-1.0.0/scheduler/tests/test_internals.py +17 -0
  60. django_tasks_scheduler-1.0.0/scheduler/tests/test_job_arg_models.py +148 -0
  61. django_tasks_scheduler-1.0.0/scheduler/tests/test_job_decorator.py +83 -0
  62. django_tasks_scheduler-1.0.0/scheduler/tests/test_mgmt_cmds.py +288 -0
  63. django_tasks_scheduler-1.0.0/scheduler/tests/test_models.py +655 -0
  64. django_tasks_scheduler-1.0.0/scheduler/tests/test_redis_models.py +29 -0
  65. django_tasks_scheduler-1.0.0/scheduler/tests/test_settings.py +100 -0
  66. django_tasks_scheduler-1.0.0/scheduler/tests/test_views.py +483 -0
  67. django_tasks_scheduler-1.0.0/scheduler/tests/test_worker.py +40 -0
  68. django_tasks_scheduler-1.0.0/scheduler/tests/testtools.py +113 -0
  69. django_tasks_scheduler-1.0.0/scheduler/tools.py +83 -0
  70. django_tasks_scheduler-1.0.0/scheduler/urls.py +21 -0
  71. django_tasks_scheduler-1.0.0/scheduler/views.py +448 -0
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2022- Daniel Moran, (Before 2016 - iStrategyLabs, LLC)
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NON INFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,57 @@
1
+ Metadata-Version: 2.1
2
+ Name: django-tasks-scheduler
3
+ Version: 1.0.0
4
+ Summary: An async job scheduler for django using redis
5
+ Home-page: https://github.com/dsoftwareinc/django-redis-scheduler
6
+ License: MIT
7
+ Keywords: redis,django,background-jobs,job-queue,task-queue,redis-queue,scheduled-jobs
8
+ Author: Daniel Moran
9
+ Author-email: daniel@moransoftware.ca
10
+ Maintainer: Daniel Moran
11
+ Maintainer-email: daniel@moransoftware.ca
12
+ Requires-Python: >=3.9,<4.0
13
+ Classifier: Development Status :: 5 - Production/Stable
14
+ Classifier: Environment :: Web Environment
15
+ Classifier: Framework :: Django
16
+ Classifier: Framework :: Django :: 3
17
+ Classifier: Framework :: Django :: 3.2
18
+ Classifier: Framework :: Django :: 4
19
+ Classifier: Framework :: Django :: 4.0
20
+ Classifier: Framework :: Django :: 4.1
21
+ Classifier: Framework :: Django :: 4.2
22
+ Classifier: Intended Audience :: Developers
23
+ Classifier: License :: OSI Approved :: MIT License
24
+ Classifier: Operating System :: OS Independent
25
+ Classifier: Programming Language :: Python
26
+ Classifier: Programming Language :: Python :: 3
27
+ Classifier: Programming Language :: Python :: 3.9
28
+ Classifier: Programming Language :: Python :: 3.10
29
+ Classifier: Programming Language :: Python :: 3.11
30
+ Provides-Extra: yaml
31
+ Requires-Dist: click (>=8.1,<9.0)
32
+ Requires-Dist: croniter (>=1.4,<2.0)
33
+ Requires-Dist: django (>=3.2)
34
+ Requires-Dist: pyyaml (>=6.0,<7.0) ; extra == "yaml"
35
+ Requires-Dist: rq (>=1.15,<2.0)
36
+ Project-URL: Bug Tracker, https://github.com/dsoftwareinc/django-tasks-scheduler/issues
37
+ Project-URL: Documentation, https://django-tasks-scheduler.readthedocs.io/en/latest/
38
+ Project-URL: Funding, https://github.com/sponsors/cunla
39
+ Description-Content-Type: text/markdown
40
+
41
+ Django Tasks Scheduler
42
+ ===================
43
+ [![Django CI](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml/badge.svg)](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml)
44
+ ![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/cunla/b756396efb895f0e34558c980f1ca0c7/raw/django-tasks-scheduler-4.json)
45
+ [![badge](https://img.shields.io/pypi/dm/django-tasks-scheduler)](https://pypi.org/project/django-tasks-scheduler/)
46
+ [![Open Source Helpers](https://www.codetriage.com/dsoftwareinc/django-tasks-scheduler/badges/users.svg)](https://www.codetriage.com/dsoftwareinc/django-tasks-scheduler)
47
+
48
+ Documentation can be found in https://django-tasks-scheduler.readthedocs.io/en/latest/
49
+
50
+ # Sponsor
51
+
52
+ django-tasks-scheduler is developed for free.
53
+
54
+ You can support this project by becoming a sponsor using [this link](https://github.com/sponsors/cunla).
55
+
56
+
57
+
@@ -0,0 +1,16 @@
1
+ Django Tasks Scheduler
2
+ ===================
3
+ [![Django CI](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml/badge.svg)](https://github.com/dsoftwareinc/django-tasks-scheduler/actions/workflows/test.yml)
4
+ ![badge](https://img.shields.io/endpoint?url=https://gist.githubusercontent.com/cunla/b756396efb895f0e34558c980f1ca0c7/raw/django-tasks-scheduler-4.json)
5
+ [![badge](https://img.shields.io/pypi/dm/django-tasks-scheduler)](https://pypi.org/project/django-tasks-scheduler/)
6
+ [![Open Source Helpers](https://www.codetriage.com/dsoftwareinc/django-tasks-scheduler/badges/users.svg)](https://www.codetriage.com/dsoftwareinc/django-tasks-scheduler)
7
+
8
+ Documentation can be found in https://django-tasks-scheduler.readthedocs.io/en/latest/
9
+
10
+ # Sponsor
11
+
12
+ django-tasks-scheduler is developed for free.
13
+
14
+ You can support this project by becoming a sponsor using [this link](https://github.com/sponsors/cunla).
15
+
16
+
@@ -0,0 +1,67 @@
1
+ [build-system]
2
+ requires = ["poetry-core"]
3
+ build-backend = "poetry.core.masonry.api"
4
+
5
+ [tool.poetry]
6
+ name = "django-tasks-scheduler"
7
+ packages = [
8
+ { include = "scheduler" },
9
+ ]
10
+ version = "1.0.0"
11
+ description = "An async job scheduler for django using redis"
12
+ readme = "README.md"
13
+ keywords = ["redis", "django", "background-jobs", "job-queue", "task-queue", "redis-queue", "scheduled-jobs"]
14
+ authors = [
15
+ "Daniel Moran <daniel@moransoftware.ca>",
16
+ ]
17
+ maintainers = [
18
+ "Daniel Moran <daniel@moransoftware.ca>",
19
+ ]
20
+ license = "MIT"
21
+ classifiers = [
22
+ 'Development Status :: 5 - Production/Stable',
23
+ 'Environment :: Web Environment',
24
+ 'Intended Audience :: Developers',
25
+ 'License :: OSI Approved :: MIT License',
26
+ 'Operating System :: OS Independent',
27
+ 'Programming Language :: Python',
28
+ 'Programming Language :: Python :: 3.9',
29
+ 'Programming Language :: Python :: 3.10',
30
+ 'Programming Language :: Python :: 3.11',
31
+ 'Framework :: Django',
32
+ 'Framework :: Django :: 4',
33
+ 'Framework :: Django :: 4.0',
34
+ 'Framework :: Django :: 4.1',
35
+ 'Framework :: Django :: 4.2',
36
+ 'Framework :: Django :: 3',
37
+ 'Framework :: Django :: 3.2',
38
+ ]
39
+ homepage = "https://github.com/dsoftwareinc/django-redis-scheduler"
40
+ documentation = "https://django-tasks-scheduler.readthedocs.io/en/latest/"
41
+
42
+ [tool.poetry.urls]
43
+ "Bug Tracker" = "https://github.com/dsoftwareinc/django-tasks-scheduler/issues"
44
+ "Funding" = "https://github.com/sponsors/cunla"
45
+
46
+ [tool.poetry.dependencies]
47
+ python = "^3.9"
48
+ django = ">=3.2"
49
+ croniter = "^1.4"
50
+ click = "^8.1"
51
+ rq = "^1.15"
52
+ pyyaml = { version = "^6.0", optional = true }
53
+
54
+ [tool.poetry.dev-dependencies]
55
+ poetry = "^1.5"
56
+ coverage = "^7"
57
+ fakeredis = { version = "^2.15", extras = ['lua'] }
58
+ Flake8-pyproject = "^1.2"
59
+
60
+ [tool.poetry.extras]
61
+ yaml = ["pyyaml"]
62
+
63
+ [tool.flake8]
64
+ max-line-length = 119
65
+ exclude = [
66
+ 'scheduler/migrations',
67
+ ]
@@ -0,0 +1,5 @@
1
+ import importlib.metadata
2
+
3
+ __version__ = importlib.metadata.version('django-tasks-scheduler')
4
+
5
+ from .decorators import job # noqa: F401
@@ -0,0 +1,2 @@
1
+ from .job import JobAdmin # noqa: F401
2
+ from .redis_models import QueueAdmin, WorkerAdmin # noqa: F401
@@ -0,0 +1,146 @@
1
+ import redis
2
+ from django.contrib import admin, messages
3
+ from django.contrib.contenttypes.admin import GenericStackedInline
4
+ from django.utils.translation import gettext_lazy as _
5
+
6
+ from scheduler import tools
7
+ from scheduler.models import CronJob, JobArg, JobKwarg, RepeatableJob, ScheduledJob
8
+ from scheduler.settings import SCHEDULER_CONFIG, logger
9
+ from scheduler.tools import get_job_executions
10
+
11
+
12
+ class HiddenMixin(object):
13
+ class Media:
14
+ js = ['admin/js/jquery.init.js', ]
15
+
16
+
17
+ class JobArgInline(HiddenMixin, GenericStackedInline):
18
+ model = JobArg
19
+ extra = 0
20
+ fieldsets = (
21
+ (None, {
22
+ 'fields': (('arg_type', 'val',),),
23
+ }),
24
+ )
25
+
26
+
27
+ class JobKwargInline(HiddenMixin, GenericStackedInline):
28
+ model = JobKwarg
29
+ extra = 0
30
+ fieldsets = (
31
+ (None, {
32
+ 'fields': (('key',), ('arg_type', 'val',),),
33
+ }),
34
+ )
35
+
36
+
37
+ @admin.register(CronJob, ScheduledJob, RepeatableJob)
38
+ class JobAdmin(admin.ModelAdmin):
39
+ LIST_DISPLAY_EXTRA = dict(
40
+ CronJob=('cron_string', 'next_run',),
41
+ ScheduledJob=('scheduled_time',),
42
+ RepeatableJob=('scheduled_time', 'interval_display'),
43
+ )
44
+ FIELDSET_EXTRA = dict(
45
+ CronJob=('cron_string', 'repeat', 'timeout', 'result_ttl',),
46
+ ScheduledJob=('scheduled_time', 'timeout', 'result_ttl'),
47
+ RepeatableJob=('scheduled_time', ('interval', 'interval_unit',), 'repeat', 'timeout', 'result_ttl',),
48
+ )
49
+ """BaseJob admin class"""
50
+ save_on_top = True
51
+ change_form_template = 'admin/scheduler/change_form.html'
52
+ actions = ['disable_selected', 'enable_selected', 'enqueue_job_now', ]
53
+ inlines = [JobArgInline, JobKwargInline, ]
54
+ list_filter = ('enabled',)
55
+ list_display = ('enabled', 'name', 'job_id', 'function_string', 'is_scheduled', 'queue',)
56
+ list_display_links = ('name',)
57
+ readonly_fields = ('job_id',)
58
+ fieldsets = (
59
+ (None, {
60
+ 'fields': ('name', 'callable', 'enabled', 'at_front',),
61
+ }),
62
+ (_('RQ Settings'), {
63
+ 'fields': ('queue', 'job_id',),
64
+ }),
65
+ )
66
+
67
+ def get_list_display(self, request):
68
+ if self.model.__name__ not in JobAdmin.LIST_DISPLAY_EXTRA:
69
+ raise ValueError(f'Unrecognized model {self.model}')
70
+ return JobAdmin.list_display + JobAdmin.LIST_DISPLAY_EXTRA[self.model.__name__]
71
+
72
+ def get_fieldsets(self, request, obj=None):
73
+ if self.model.__name__ not in JobAdmin.FIELDSET_EXTRA:
74
+ raise ValueError(f'Unrecognized model {self.model}')
75
+ return JobAdmin.fieldsets + ((_('Scheduling'), {
76
+ 'fields': JobAdmin.FIELDSET_EXTRA[self.model.__name__],
77
+ }),)
78
+
79
+ @admin.display(description='Next run')
80
+ def next_run(self, o: CronJob):
81
+ return tools.get_next_cron_time(o.cron_string)
82
+
83
+ def change_view(self, request, object_id, form_url='', extra_context=None):
84
+ extra = extra_context or {}
85
+ obj = self.get_object(request, object_id)
86
+ try:
87
+ execution_list = get_job_executions(obj.queue, obj)
88
+ except redis.ConnectionError as e:
89
+ logger.warn(f'Could not get job executions: {e}')
90
+ execution_list = list()
91
+ paginator = self.get_paginator(request, execution_list, SCHEDULER_CONFIG['EXECUTIONS_IN_PAGE'])
92
+ page_number = request.GET.get('p', 1)
93
+ page_obj = paginator.get_page(page_number)
94
+ page_range = paginator.get_elided_page_range(page_obj.number)
95
+
96
+ extra.update({
97
+ "pagination_required": paginator.count > SCHEDULER_CONFIG['EXECUTIONS_IN_PAGE'],
98
+ 'executions': page_obj,
99
+ 'page_range': page_range,
100
+ 'page_var': 'p',
101
+ })
102
+
103
+ return super(JobAdmin, self).change_view(
104
+ request, object_id, form_url, extra_context=extra)
105
+
106
+ def delete_queryset(self, request, queryset):
107
+ for job in queryset:
108
+ job.unschedule()
109
+ super(JobAdmin, self).delete_queryset(request, queryset)
110
+
111
+ def delete_model(self, request, obj):
112
+ obj.unschedule()
113
+ super(JobAdmin, self).delete_model(request, obj)
114
+
115
+ @admin.action(description=_("Disable selected %(verbose_name_plural)s"), permissions=('change',))
116
+ def disable_selected(self, request, queryset):
117
+ rows_updated = 0
118
+ for obj in queryset.filter(enabled=True).iterator():
119
+ obj.enabled = False
120
+ obj.unschedule()
121
+ rows_updated += 1
122
+
123
+ message_bit = "1 job was" if rows_updated == 1 else f"{rows_updated} jobs were"
124
+
125
+ level = messages.WARNING if not rows_updated else messages.INFO
126
+ self.message_user(request, f"{message_bit} successfully disabled and unscheduled.", level=level)
127
+
128
+ @admin.action(description=_("Enable selected %(verbose_name_plural)s"), permissions=('change',))
129
+ def enable_selected(self, request, queryset):
130
+ rows_updated = 0
131
+ for obj in queryset.filter(enabled=False).iterator():
132
+ obj.enabled = True
133
+ obj.save()
134
+ rows_updated += 1
135
+
136
+ message_bit = "1 job was" if rows_updated == 1 else f"{rows_updated} jobs were"
137
+ level = messages.WARNING if not rows_updated else messages.INFO
138
+ self.message_user(request, f"{message_bit} successfully enabled and scheduled.", level=level)
139
+
140
+ @admin.action(description="Enqueue now", permissions=('change',))
141
+ def enqueue_job_now(self, request, queryset):
142
+ job_names = []
143
+ for job in queryset:
144
+ job.enqueue_to_run()
145
+ job_names.append(job.name)
146
+ self.message_user(request, f"The following jobs have been enqueued: {', '.join(job_names)}", )
@@ -0,0 +1,44 @@
1
+ from django.contrib import admin
2
+
3
+ from scheduler import views
4
+ from scheduler.models import Queue
5
+ from scheduler.models.worker import Worker
6
+
7
+
8
+ class ImmutableAdmin(admin.ModelAdmin):
9
+ def has_add_permission(self, request):
10
+ return False # Hide the admin "+ Add" link for Queues
11
+
12
+ def has_change_permission(self, request, obj=None):
13
+ return True
14
+
15
+ def has_module_permission(self, request):
16
+ """
17
+ return True if the given request has any permission in the given
18
+ app label.
19
+
20
+ Can be overridden by the user in subclasses. In such case it should
21
+ return True if the given request has permission to view the module on
22
+ the admin index page and access the module's index page. Overriding it
23
+ does not restrict access to the add, change or delete views. Use
24
+ `ModelAdmin.has_(add|change|delete)_permission` for that.
25
+ """
26
+ return request.user.has_module_perms('django-tasks-scheduler')
27
+
28
+
29
+ @admin.register(Queue)
30
+ class QueueAdmin(ImmutableAdmin):
31
+ """Admin View for queues"""
32
+
33
+ def changelist_view(self, request, extra_context=None):
34
+ """The 'change list' admin view for this model."""
35
+ return views.stats(request)
36
+
37
+
38
+ @admin.register(Worker)
39
+ class WorkerAdmin(ImmutableAdmin):
40
+ """Admin View for workers"""
41
+
42
+ def changelist_view(self, request, extra_context=None):
43
+ """The 'change list' admin view for this model."""
44
+ return views.workers(request)
@@ -0,0 +1,11 @@
1
+ from django.apps import AppConfig
2
+ from django.utils.translation import gettext_lazy as _
3
+
4
+
5
+ class SchedulerConfig(AppConfig):
6
+ default_auto_field = 'django.db.models.AutoField'
7
+ name = 'scheduler'
8
+ verbose_name = _('Tasks Scheduler')
9
+
10
+ def ready(self):
11
+ pass
@@ -0,0 +1,43 @@
1
+ from scheduler import settings
2
+ from .queues import get_queue, QueueNotFoundError
3
+ from .rq_classes import rq_job_decorator
4
+
5
+
6
+ def job(*args, **kwargs):
7
+ """
8
+ The same as rq package's job decorator, but it automatically works out
9
+ the ``connection`` argument from SCHEDULER_QUEUES.
10
+
11
+ And also, it allows simplified ``@job`` syntax to put job into
12
+ default queue.
13
+
14
+ """
15
+ if len(args) == 0:
16
+ func = None
17
+ queue = 'default'
18
+ else:
19
+ if callable(args[0]):
20
+ func = args[0]
21
+ queue = 'default'
22
+ else:
23
+ func = None
24
+ queue = args[0]
25
+ args = args[1:]
26
+
27
+ if isinstance(queue, str):
28
+ try:
29
+ queue = get_queue(queue)
30
+ if 'connection' not in kwargs:
31
+ kwargs['connection'] = queue.connection
32
+ except KeyError:
33
+ raise QueueNotFoundError(f'Queue {queue} does not exist')
34
+
35
+ config = settings.SCHEDULER_CONFIG
36
+
37
+ kwargs.setdefault('result_ttl', config.get('DEFAULT_RESULT_TTL'))
38
+ kwargs.setdefault('timeout', config.get('DEFAULT_TIMEOUT'))
39
+
40
+ decorator = rq_job_decorator(queue, *args, **kwargs)
41
+ if func:
42
+ return decorator(func)
43
+ return decorator
@@ -0,0 +1,31 @@
1
+ import click
2
+ from django.core.management.base import BaseCommand
3
+
4
+ from scheduler.queues import get_queue
5
+ from scheduler.rq_classes import JobExecution
6
+
7
+
8
+ class Command(BaseCommand):
9
+ help = 'Delete failed jobs from Django queue.'
10
+
11
+ def add_arguments(self, parser):
12
+ parser.add_argument(
13
+ '--queue', '-q', dest='queue', default='default',
14
+ help='Specify the queue [default]')
15
+ parser.add_argument('-f', '--func', help='optional job function name, e.g. "app.tasks.func"')
16
+ parser.add_argument('--dry-run', action='store_true', help='Do not actually delete failed jobs')
17
+
18
+ def handle(self, *args, **options):
19
+ queue = get_queue(options.get('queue', 'default'))
20
+ job_ids = queue.failed_job_registry.get_job_ids()
21
+ jobs = [JobExecution.fetch(job_id, connection=queue.connection) for job_id in job_ids]
22
+ func_name = options.get('func', None)
23
+ if func_name is not None:
24
+ jobs = [job for job in jobs if job.func_name == func_name]
25
+ dry_run = options.get('dry_run', False)
26
+ click.echo(f'Found {len(jobs)} failed jobs')
27
+ for job in jobs:
28
+ click.echo(f'Deleting {job.id}')
29
+ if not dry_run:
30
+ job.delete()
31
+ click.echo(f'Deleted {len(jobs)} failed jobs')
@@ -0,0 +1,64 @@
1
+ import sys
2
+
3
+ import click
4
+ from django.apps import apps
5
+ from django.core.management.base import BaseCommand
6
+
7
+ from scheduler.tools import MODEL_NAMES
8
+
9
+
10
+ class Command(BaseCommand):
11
+ """
12
+ Export all scheduled jobs
13
+ """
14
+ help = __doc__
15
+
16
+ def add_arguments(self, parser):
17
+ parser.add_argument(
18
+ '-o', '--output',
19
+ action='store',
20
+ choices=['json', 'yaml'],
21
+ default='json',
22
+ dest='format',
23
+ help='format of output',
24
+ )
25
+
26
+ parser.add_argument(
27
+ '-e', '--enabled',
28
+ action='store_true',
29
+ dest='enabled',
30
+ help='Export only enabled jobs',
31
+ )
32
+ parser.add_argument(
33
+ '-f', '--filename',
34
+ action='store',
35
+ dest='filename',
36
+ help='File name to load (otherwise writes to standard output)',
37
+ )
38
+
39
+ def handle(self, *args, **options):
40
+ file = open(options.get('filename'), 'w') if options.get("filename") else sys.stdout
41
+ res = list()
42
+ for model_name in MODEL_NAMES:
43
+ model = apps.get_model(app_label='scheduler', model_name=model_name)
44
+ jobs = model.objects.all()
45
+ if options.get('enabled'):
46
+ jobs = jobs.filter(enabled=True)
47
+ for job in jobs:
48
+ res.append(job.to_dict())
49
+
50
+ if options.get("format") == 'json':
51
+ import json
52
+ click.echo(json.dumps(res, indent=2), file=file)
53
+ return
54
+
55
+ if options.get("format") == 'yaml':
56
+ try:
57
+ import yaml
58
+ except ImportError:
59
+ click.echo("Aborting. LibYAML is not installed.")
60
+ exit(1)
61
+ # Disable YAML alias
62
+ yaml.Dumper.ignore_aliases = lambda *x: True
63
+ click.echo(yaml.dump(res, default_flow_style=False), file=file)
64
+ return
@@ -0,0 +1,109 @@
1
+ import sys
2
+
3
+ import click
4
+ from django.apps import apps
5
+ from django.conf import settings
6
+ from django.contrib.contenttypes.models import ContentType
7
+ from django.core.management.base import BaseCommand
8
+ from django.utils import timezone
9
+
10
+ from scheduler.models import JobArg, JobKwarg
11
+ from scheduler.tools import MODEL_NAMES
12
+
13
+
14
+ def create_job_from_dict(job_dict, update):
15
+ model = apps.get_model(app_label='scheduler', model_name=job_dict['model'])
16
+ existing_job = model.objects.filter(name=job_dict['name']).first()
17
+ if existing_job:
18
+ if update:
19
+ click.echo(f'Found existing job "{existing_job}, removing it to be reinserted"')
20
+ existing_job.delete()
21
+ else:
22
+ click.echo(f'Found existing job "{existing_job}", skipping')
23
+ return
24
+ kwargs = dict(job_dict)
25
+ del kwargs['model']
26
+ del kwargs['callable_args']
27
+ del kwargs['callable_kwargs']
28
+ if kwargs.get('scheduled_time', None):
29
+ kwargs['scheduled_time'] = timezone.datetime.fromisoformat(kwargs['scheduled_time'])
30
+ if not settings.USE_TZ:
31
+ kwargs['scheduled_time'] = timezone.make_naive(kwargs['scheduled_time'])
32
+ model_fields = set(map(lambda field: field.attname, model._meta.get_fields()))
33
+ keys_to_ignore = list(filter(lambda k: k not in model_fields, kwargs.keys()))
34
+ for k in keys_to_ignore:
35
+ del kwargs[k]
36
+ scheduled_job = model.objects.create(**kwargs)
37
+ click.echo(f'Created job {scheduled_job}')
38
+ content_type = ContentType.objects.get_for_model(scheduled_job)
39
+
40
+ for arg in job_dict['callable_args']:
41
+ JobArg.objects.create(
42
+ content_type=content_type, object_id=scheduled_job.id, **arg, )
43
+ for arg in job_dict['callable_kwargs']:
44
+ JobKwarg.objects.create(
45
+ content_type=content_type, object_id=scheduled_job.id, **arg, )
46
+
47
+
48
+ class Command(BaseCommand):
49
+ """
50
+ Import scheduled jobs
51
+ """
52
+ help = __doc__
53
+
54
+ def add_arguments(self, parser):
55
+ parser.add_argument(
56
+ '-f', '--format',
57
+ action='store',
58
+ choices=['json', 'yaml'],
59
+ default='json',
60
+ dest='format',
61
+ help='format of input',
62
+ )
63
+ parser.add_argument(
64
+ '--filename',
65
+ action='store',
66
+ dest='filename',
67
+ help='File name to load (otherwise loads from standard input)',
68
+ )
69
+
70
+ parser.add_argument(
71
+ '-r', '--reset',
72
+ action='store_true',
73
+ dest='reset',
74
+ help='Remove all currently scheduled jobs before importing',
75
+ )
76
+ parser.add_argument(
77
+ '-u', '--update',
78
+ action='store_true',
79
+ dest='update',
80
+ help='Update existing records',
81
+ )
82
+
83
+ def handle(self, *args, **options):
84
+ file = open(options.get('filename')) if options.get("filename") else sys.stdin
85
+ jobs = list()
86
+ if options.get("format") == 'json':
87
+ import json
88
+ try:
89
+ jobs = json.load(file)
90
+ except json.decoder.JSONDecodeError:
91
+ click.echo('Error decoding json', err=True)
92
+ exit(1)
93
+ elif options.get("format") == 'yaml':
94
+ try:
95
+ import yaml
96
+ except ImportError:
97
+ click.echo("Aborting. LibYAML is not installed.")
98
+ exit(1)
99
+ # Disable YAML alias
100
+ yaml.Dumper.ignore_aliases = lambda *x: True
101
+ jobs = yaml.load(file, yaml.SafeLoader)
102
+
103
+ if options.get('reset'):
104
+ for model_name in MODEL_NAMES:
105
+ model = apps.get_model(app_label='scheduler', model_name=model_name)
106
+ model.objects.all().delete()
107
+
108
+ for job in jobs:
109
+ create_job_from_dict(job, update=options.get('update'))