Source code for ajenti.plugins.tasks.api

import gevent
import logging
import traceback
import uuid

from ajenti.api import *

[docs]class TaskResult (object): SUCCESS = 0 ABORTED = 1 ERROR = 2 CRASH = 3 def __init__(self): self.result = TaskResult.SUCCESS self.output = '' = None
[docs]class TaskError (Exception): pass
[docs]class Task (object): """ Base class for custom tasks :param name: display name :param ui: full layout name for parameter editor, will be bound to parameter dictionary (so begin it with <bind:dict bind="params">) :param hidden: if True, task won't be available for manual creation """ name = '---' ui = None hidden = False def __init__(self, **kwargs): self.params = kwargs
[docs] def init(self): self._progress = 0 self._progress_max = 1 self.running = False self.complete = False self.pending = False self.aborted = False self.parallel = False self.message = '' self.result = TaskResult() self.callback = lambda x: None
[docs] def start(self): self.thread = gevent.spawn(self._run)
def _run(self):'Starting task %s' % self.__class__.__name__) self.running = True = try:**self.params) self.result.result = TaskResult.SUCCESS except TaskError as e: self.result.result = TaskResult.ERROR self.result.output = e.message except Exception as e: traceback.print_exc() self.result.result = TaskResult.CRASH self.result.output = str(e) logging.exception(str(e)) self.running = False self.complete = True'Task %s complete (%s)' % (self.__class__.__name__, 'aborted' if self.aborted else 'success')) self.callback(self)
[docs] def run(**kwargs): """ Override with your task actions here. Raise :class:`TaskError` in case of emergency. Check `aborted` often and return if it's True """
[docs] def abort(self): if not self.running: return self.aborted = True self.result.result = TaskResult.ABORTED self.thread.join()
[docs] def set_progress(self, current, max): self._progress, self._progress_max = current, max
[docs] def get_progress(self): return self._progress, self._progress_max
[docs]class TaskDefinition (object): def __init__(self, j={}, task_class=None): = j.get('name', 'unnamed') self.parallel = j.get('parallel', False) self.task_class = j.get('task_class', task_class) self.params = j.get('params', self.get_class().default_params.copy() if self.get_class() else {}) = j.get('id', str(uuid.uuid4()))
[docs] def get_class(self): for task in Task.get_classes(): if task.classname == self.task_class: return task
[docs] def save(self): return { 'name':, 'task_class': self.task_class, 'params': self.params, 'id':, }
[docs]class JobDefinition (object): def __init__(self, j={}): = j.get('name', 'unnamed') self.task_id = j.get('task_id', None) = j.get('id', str(uuid.uuid4())) self.schedule_special = j.get('schedule_special', None) self.schedule_minute = j.get('schedule_minute', '0') for _ in ['hour', 'day_of_month', 'month', 'day_of_week']: setattr(self, 'schedule_' + _, j.get('schedule_' + _, '*'))
[docs] def save(self): return { 'name':, 'task_id': self.task_id, 'id':, 'schedule_special': self.schedule_special, 'schedule_minute': self.schedule_minute, 'schedule_hour': self.schedule_hour, 'schedule_day_of_month': self.schedule_day_of_month, 'schedule_month': self.schedule_month, 'schedule_day_of_week': self.schedule_day_of_week, }
comments powered by Disqus