REPR_OUTPUT_SIZE = 10
PENDING = 'pending'
COMPLETED = 'completed'
+DELETED = 'deleted'
+WAITING = 'waiting'
+RECURRING = 'recurring'
logger = logging.getLogger(__name__)
# their data dics are the same
return self.task == other.task and self._data == other._data
- __repr__ = __unicode__
-
-
-class LazyUUIDTask(object):
- """
- A lazy wrapper around Task object, referenced by UUID.
-
- - Supports comparison with LazyUUIDTask or Task objects (equality by UUIDs)
- - If any attribute other than 'uuid' requested, a lookup in the
- backend will be performed and this object will be replaced by a proper
- Task object.
- """
-
- def __init__(self, tw, uuid):
- self._tw = tw
- self._uuid = uuid
-
- def __getitem__(self, key):
- # LazyUUIDTask does not provide anything else other than 'uuid'
- if key is 'uuid':
- return self._uuid
- else:
- self.replace()
- return self[key]
-
- def __getattr__(self, name):
- # Getattr is called only if the attribute could not be found using
- # normal means
- self.replace()
- return self.name
-
- def __eq__(self, other):
- if other['uuid']:
- # For saved Tasks, just define equality by equality of uuids
- return self['uuid'] == other['uuid']
-
- def __hash__(self):
- return self['uuid'].__hash__()
-
- def replace(self):
- """
- Performs conversion to the regular Task object, referenced by the
- stored UUID.
- """
-
- replacement = self._tw.tasks.get(uuid=self._uuid)
- self.__class__ = replacement.__class__
- self.__dict__ = replacement.__dict__
-
-
-class LazyUUIDTaskSet(object):
- """
- A lazy wrapper around TaskQuerySet object, for tasks referenced by UUID.
+ def __ne__(self, other):
+ return not self.__eq__(other)
- - Supports 'in' operator with LazyUUIDTask or Task objects
- - If iteration over the objects in the LazyUUIDTaskSet is requested, the
- LazyUUIDTaskSet will be converted to QuerySet and evaluated
- """
-
- def __init__(self, tw, uuids):
- self._tw = tw
- self._uuids = set(uuids)
-
- def __getattr__(self, name):
- # Getattr is called only if the attribute could not be found using
- # normal means
- self.replace()
- return self.name
-
- def __eq__(self, other):
- return set(t['uuid'] for t in other) == self._uuids
-
- def __contains__(self, task):
- return task['uuid'] in self._uuids
-
- def __len__(self):
- return len(self._uuids)
-
- def __iter__(self):
- self.replace()
- for task in self:
- yield task
-
- def replace(self):
- """
- Performs conversion to the regular TaskQuerySet object, referenced by
- the stored UUIDs.
- """
-
- replacement = self._tw.tasks.filter(' '.join(self._uuids))
- self.__class__ = replacement.__class__
- self.__dict__ = replacement.__dict__
+ __repr__ = __unicode__
class Task(TaskResource):
# If the tasks are not saved, compare the actual instances
return id(self) == id(other)
+ def __ne__(self, other):
+ return not self.__eq__(other)
+
def __hash__(self):
if self['uuid']:
# For saved Tasks, just define equality by equality of uuids
def pending(self):
return self['status'] == six.text_type('pending')
+ @property
+ def recurring(self):
+ return self['status'] == six.text_type('recurring')
+
@property
def active(self):
return self['start'] is not None
# Check that all the tasks are saved
for task in (cur_dependencies or set()):
if not task.saved:
- raise Task.NotSaved('Task \'%s\' needs to be saved before '
- 'it can be set as dependency.' % task)
+ raise Task.NotSaved(
+ 'Task \'%s\' needs to be saved before '
+ 'it can be set as dependency.' % task,
+ )
return super(Task, self).serialize_depends(cur_dependencies)
def delete(self):
if not self.saved:
- raise Task.NotSaved("Task needs to be saved before it can be deleted")
+ raise Task.NotSaved(
+ 'Task needs to be saved before it can be deleted',
+ )
# Refresh the status, and raise exception if the task is deleted
self.refresh(only_fields=['status'])
if self.deleted:
- raise Task.DeletedTask("Task was already deleted")
+ raise Task.DeletedTask('Task was already deleted')
self.backend.delete_task(self)
def start(self):
if not self.saved:
- raise Task.NotSaved("Task needs to be saved before it can be started")
+ raise Task.NotSaved(
+ 'Task needs to be saved before it can be started',
+ )
# Refresh, and raise exception if task is already completed/deleted
self.refresh(only_fields=['status'])
if self.completed:
- raise Task.CompletedTask("Cannot start a completed task")
+ raise Task.CompletedTask('Cannot start a completed task')
elif self.deleted:
- raise Task.DeletedTask("Deleted task cannot be started")
+ raise Task.DeletedTask('Deleted task cannot be started')
elif self.active:
- raise Task.ActiveTask("Task is already active")
+ raise Task.ActiveTask('Task is already active')
self.backend.start_task(self)
def stop(self):
if not self.saved:
- raise Task.NotSaved("Task needs to be saved before it can be stopped")
+ raise Task.NotSaved(
+ 'Task needs to be saved before it can be stopped',
+ )
# Refresh, and raise exception if task is already completed/deleted
self.refresh(only_fields=['status'])
if not self.active:
- raise Task.InactiveTask("Cannot stop an inactive task")
+ raise Task.InactiveTask('Cannot stop an inactive task')
self.backend.stop_task(self)
def done(self):
if not self.saved:
- raise Task.NotSaved("Task needs to be saved before it can be completed")
+ raise Task.NotSaved(
+ 'Task needs to be saved before it can be completed',
+ )
# Refresh, and raise exception if task is already completed/deleted
self.refresh(only_fields=['status'])
if self.completed:
- raise Task.CompletedTask("Cannot complete a completed task")
+ raise Task.CompletedTask('Cannot complete a completed task')
elif self.deleted:
- raise Task.DeletedTask("Deleted task cannot be completed")
+ raise Task.DeletedTask('Deleted task cannot be completed')
self.backend.complete_task(self)
def add_annotation(self, annotation):
if not self.saved:
- raise Task.NotSaved("Task needs to be saved to add annotation")
+ raise Task.NotSaved('Task needs to be saved to add annotation')
self.backend.annotate_task(self, annotation)
self.refresh(only_fields=['annotations'])
def remove_annotation(self, annotation):
if not self.saved:
- raise Task.NotSaved("Task needs to be saved to remove annotation")
+ raise Task.NotSaved('Task needs to be saved to remove annotation')
if isinstance(annotation, TaskAnnotation):
annotation = annotation['description']
def refresh(self, only_fields=None, after_save=False):
# Raise error when trying to refresh a task that has not been saved
if not self.saved:
- raise Task.NotSaved("Task needs to be saved to be refreshed")
+ raise Task.NotSaved('Task needs to be saved to be refreshed')
new_data = self.backend.refresh_task(self, after_save=after_save)
if only_fields:
to_update = dict(
- [(k, new_data.get(k)) for k in only_fields])
+ [(k, new_data.get(k)) for k in only_fields],
+ )
self._update_data(to_update, update_original=True)
else:
self._load_data(new_data)
def __repr__(self):
data = list(self[:REPR_OUTPUT_SIZE + 1])
if len(data) > REPR_OUTPUT_SIZE:
- data[-1] = "...(remaining elements truncated)..."
+ data[-1] = '...(remaining elements truncated)...'
return repr(data)
def __len__(self):
def completed(self):
return self.filter(status=COMPLETED)
+ def deleted(self):
+ return self.filter(status=DELETED)
+
+ def waiting(self):
+ return self.filter(status=WAITING)
+
+ def recurring(self):
+ return self.filter(status=RECURRING)
+
def filter(self, *args, **kwargs):
"""
Returns a new TaskQuerySet with the given filters added.
if not num:
raise Task.DoesNotExist(
'Task matching query does not exist. '
- 'Lookup parameters were {0}'.format(kwargs))
+ 'Lookup parameters were {0}'.format(kwargs),
+ )
raise ValueError(
'get() returned more than one Task -- it returned {0}! '
- 'Lookup parameters were {1}'.format(num, kwargs))
+ 'Lookup parameters were {1}'.format(num, kwargs),
+ )