# `django_celery_beat.admin`

Periodic Task Admin interface.

class django_celery_beat.admin.ClockedScheduleAdmin(model, admin_site)

  Admin-interface for clocked schedules.

  fields = ('clocked_time',)
  list_display = ('clocked_time',)
  property media

class django_celery_beat.admin.CrontabScheduleAdmin(model, admin_site)

  Admin class for CrontabSchedule.

  fields = ('human_readable', 'minute', 'hour', 'day_of_month', 'month_of_year', 'day_of_week', 'timezone')
  list_display = ('__str__', 'human_readable')
  property media
  readonly_fields = ('human_readable',)

class django_celery_beat.admin.IntervalScheduleAdmin(model, admin_site)

  Admin class for IntervalSchedule.

  property media

class django_celery_beat.admin.PeriodicTaskAdmin(model, admin_site)

  Admin-interface for periodic tasks.

  actions = ('enable_tasks', 'disable_tasks', 'toggle_tasks', 'run_tasks')
  celery_app = <Celery proj>
  change_form_template = 'admin/djcelery/change_periodictask_form.html'
  changeform_view(request, object_id=None, form_url='', extra_context=None)
  changelist_view(request, extra_context=None)

    The ‘change list’ admin view for this model.

  crontab_translation(obj)
  date_hierarchy = 'start_time'
  disable_tasks(request, queryset)
  enable_tasks(request, queryset)
  form

    alias of `PeriodicTaskForm`

  get_queryset(request)

    Return a QuerySet of all model instances that can be edited by the admin site. This is used by changelist_view.

  list_display = ('name', 'enabled', 'scheduler', 'interval', 'start_time', 'last_run_at', 'one_off')
  list_filter = ['enabled', 'one_off', 'task', 'start_time', 'last_run_at']
  property media
  model

    alias of `PeriodicTask`

  readonly_fields = ('last_run_at', 'crontab_translation')
  run_tasks(request, queryset)
  search_fields = ('name',)
  toggle_tasks(request, queryset)

class django_celery_beat.admin.PeriodicTaskForm(data=None, files=None, auto_id='id_%s', prefix=None, initial=None, error_class=<class 'django.forms.utils.ErrorList'>, label_suffix=None, empty_permitted=False, instance=None, use_required_attribute=None, renderer=None)

  Form that lets you create and modify periodic tasks.

  Form fields:

  - `name`: Name (`CharField`)

  - `task`: Task (custom) (`CharField`)

  - `interval`: Interval Schedule (`ModelChoiceField`)

  - `crontab`: Crontab Schedule (`ModelChoiceField`)

  - `solar`: Solar Schedule (`ModelChoiceField`)

  - `clocked`: Clocked Schedule (`ModelChoiceField`)

  - `args`: Positional Arguments (`CharField`)

  - `kwargs`: Keyword Arguments (`CharField`)

  - `queue`: Queue Override (`CharField`)

  - `exchange`: Exchange (`CharField`)

  - `routing_key`: Routing Key (`CharField`)

  - `headers`: AMQP Message Headers (`CharField`)

  - `priority`: Priority (`IntegerField`)

  - `expires`: Expires Datetime (`DateTimeField`)

  - `expire_seconds`: Expires timedelta with seconds (`IntegerField`)

  - `one_off`: One-off Task (`BooleanField`)

  - `start_time`: Start Datetime (`DateTimeField`)

  - `enabled`: Enabled (`BooleanField`)

  - `description`: Description (`CharField`)

  - `regtask`: Task (registered) (`TaskChoiceField`)

  clean()

    Hook for doing any extra form-wide cleaning after Field.clean() has been called on every field. Any ValidationError raised by this method will not be associated with a particular field; it will have a special-case association with the field named ‘__all__’.

  clean_args()
  clean_kwargs()
  property media

    Return all media required to render the widgets on this form.

class django_celery_beat.admin.PeriodicTaskInline(parent_model, admin_site)
  can_delete = False
  extra = 0
  fields = ('name', 'task', 'args', 'kwargs')
  has_add_permission(request, obj)

    Return True if the given request has permission to add an object. Can be overridden by the user in subclasses.

  property media
  model

    alias of `PeriodicTask`

  readonly_fields = ('name', 'task', 'args', 'kwargs')
  show_change_link = True
  verbose_name = 'Periodic Tasks Using This Schedule'
  verbose_name_plural = 'Periodic Tasks Using This Schedule'

class django_celery_beat.admin.ScheduleAdmin(model, admin_site)
  inlines = [<class 'django_celery_beat.admin.PeriodicTaskInline'>]
  property media

class django_celery_beat.admin.SolarScheduleAdmin(model, admin_site)

  Admin class for SolarSchedule.

  property media

class django_celery_beat.admin.TaskChoiceField(*, choices=(), **kwargs)

  Field that lets you choose between task names.

  valid_value(value)

    Check to see if the provided value is a valid choice.

  widget

    alias of `TaskSelectWidget`

class django_celery_beat.admin.TaskSelectWidget(attrs=None, choices=())

  Widget that lets you choose between task names.

  celery_app = <Celery proj>
  property choices
  property media
  tasks_as_choices()