Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Adding name col to CrontabSchedule model #478

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Adding name col to CrontabSchedule model #478

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
9be0fd7
Adding name col to CrontabSchedule model.
trianglesis Dec 15, 2021
5eeb123
Adding name col to CrontabSchedule model.
trianglesis Dec 15, 2021
27927ad
Adding name col to CrontabSchedule model. Add migrations.
trianglesis Dec 15, 2021
58f1743
Adding name col to CrontabSchedule model. Add migrations. Generated b…
trianglesis Dec 17, 2021
d96af9c
Merge branch 'celery:master' into master
trianglesis Dec 18, 2021
35ac4dc
django_celery_beat admin.py PeriodicTaskAdmin
Jan 24, 2022
b3ecccc
django_celery_beat admin.py PeriodicTaskAdmin
Jan 24, 2022
21de9a1
django_celery_beat admin.py PeriodicTaskAdmin
Jan 25, 2022
9bb7fa4
django_celery_beat admin.py PeriodicTaskAdmin
Jan 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions django_celery_beat/admin.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,9 +116,9 @@ class PeriodicTaskAdmin(admin.ModelAdmin):
model = PeriodicTask
celery_app = current_app
date_hierarchy = 'start_time'
list_display = ('__str__', 'enabled', 'interval', 'start_time',
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why str is removed?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When using str there is no possible way to sort\group tasks by name.
Name is an essential feature that can be used to make sort easy and cron tasks more meaningful.

image

In this example, I can add prefixes in the name, and be able to group all tasks by any logical human-understandable meaning.

In addition, I think there is no need to add extra fields in the name when we have separate Crontab, Interval columns in the table already.

list_display = ('name', 'enabled', 'crontab', 'interval', 'start_time',
'last_run_at', 'one_off')
list_filter = ['enabled', 'one_off', 'task', 'start_time', 'last_run_at']
list_filter = ['enabled', 'one_off', 'task', 'start_time', 'last_run_at', 'crontab']
actions = ('enable_tasks', 'disable_tasks', 'toggle_tasks', 'run_tasks')
search_fields = ('name',)
fieldsets = (
Expand All @@ -133,7 +133,7 @@ class PeriodicTaskAdmin(admin.ModelAdmin):
}),
('Arguments', {
'fields': ('args', 'kwargs'),
'classes': ('extrapretty', 'wide', 'collapse', 'in'),
'classes': ('extrapretty', 'wide', 'in'),
}),
('Execution Options', {
'fields': ('expires', 'expire_seconds', 'queue', 'exchange',
Expand Down
18 changes: 18 additions & 0 deletions django_celery_beat/migrations/0016_crontabschedule_name.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Generated by Django 3.2 on 2021-12-17 07:58

from django.db import migrations, models


class Migration(migrations.Migration):

dependencies = [
('django_celery_beat', '0015_edit_solarschedule_events_choices'),
]

operations = [
migrations.AddField(
model_name='crontabschedule',
name='name',
field=models.CharField(blank=True, help_text='Short Description For This Cron Schedule', max_length=200, null=True, verbose_name='Name'),
),
]
17 changes: 13 additions & 4 deletions django_celery_beat/models.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,6 +299,13 @@ class CrontabSchedule(models.Model):
'Timezone to Run the Cron Schedule on. Default is UTC.'),
)

name = models.CharField(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would also like to have unit tests for new proposed changes

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't run any test from test_schedulers.py with the current setup.
Will try to figure out what am I doing wrong, and possibly add some tests.

max_length=200, unique=False,
null=True, blank=True,
verbose_name=_('Name'),
help_text=_('Short Description For This Cron Schedule'),
)

class Meta:
"""Table information."""

Expand All @@ -308,10 +315,12 @@ class Meta:
'day_of_week', 'hour', 'minute', 'timezone']

def __str__(self):
return '{0} {1} {2} {3} {4} (m/h/dM/MY/d) {5}'.format(

return '{0} {1} {2} {3} {4} (m/h/dM/MY/d) {5} {6}'.format(
cronexp(self.minute), cronexp(self.hour),
cronexp(self.day_of_month), cronexp(self.month_of_year),
cronexp(self.day_of_week), str(self.timezone)
cronexp(self.day_of_week), str(self.timezone),
'[{}]'.format(self.name) if self.name else '',
)

@property
Expand Down Expand Up @@ -593,9 +602,9 @@ def expires_(self):
def __str__(self):
fmt = '{0.name}: {{no schedule}}'
if self.interval:
fmt = '{0.name}: {0.interval}'
fmt = '{0.name}'
if self.crontab:
fmt = '{0.name}: {0.crontab}'
fmt = '{0.name}'
if self.solar:
fmt = '{0.name}: {0.solar}'
if self.clocked:
Expand Down