pass
-class TaskResource(object):
+class SerializingObject(object):
+ """
+ Common ancestor for TaskResource & TaskFilter, since they both
+ need to serialize arguments.
+ """
+
+ def _deserialize(self, key, value):
+ hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
+ lambda x: x if x != '' else None)
+ return hydrate_func(value)
+
+ def _serialize(self, key, value):
+ dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
+ lambda x: x if x is not None else '')
+ return dehydrate_func(value)
+
+ def timestamp_serializer(self, date):
+ if not date:
+ return None
+ return date.strftime(DATE_FORMAT)
+
+ def timestamp_deserializer(self, date_str):
+ if not date_str:
+ return None
+ return datetime.datetime.strptime(date_str, DATE_FORMAT)
+
+ def serialize_entry(self, value):
+ return self.timestamp_serializer(value)
+
+ def deserialize_entry(self, value):
+ return self.timestamp_deserializer(value)
+
+ def serialize_modified(self, value):
+ return self.timestamp_serializer(value)
+
+ def deserialize_modified(self, value):
+ return self.timestamp_deserializer(value)
+
+ def serialize_due(self, value):
+ return self.timestamp_serializer(value)
+
+ def deserialize_due(self, value):
+ return self.timestamp_deserializer(value)
+
+ def serialize_scheduled(self, value):
+ return self.timestamp_serializer(value)
+
+ def deserialize_scheduled(self, value):
+ return self.timestamp_deserializer(value)
+
+ def serialize_until(self, value):
+ return self.timestamp_serializer(value)
+
+ def deserialize_until(self, value):
+ return self.timestamp_deserializer(value)
+
+ def serialize_wait(self, value):
+ return self.timestamp_serializer(value)
+
+ def deserialize_wait(self, value):
+ return self.timestamp_deserializer(value)
+
+ def deserialize_annotations(self, data):
+ return [TaskAnnotation(self, d) for d in data] if data else []
+
+ def serialize_tags(self, tags):
+ return ','.join(tags) if tags else ''
+
+ def deserialize_tags(self, tags):
+ if isinstance(tags, basestring):
+ return tags.split(',') if tags else []
+ return tags
+
+ def serialize_depends(self, cur_dependencies):
+ # Return the list of uuids
+ return ','.join(task['uuid'] for task in cur_dependencies)
+
+ def deserialize_depends(self, raw_uuids):
+ raw_uuids = raw_uuids or '' # Convert None to empty string
+ uuids = raw_uuids.split(',')
+ return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
+
+
+class TaskResource(SerializingObject):
read_only_fields = []
def _load_data(self, data):
raise RuntimeError('Field \'%s\' is read-only' % key)
self._data[key] = self._serialize(key, value)
- def _deserialize(self, key, value):
- hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
- lambda x: x)
- return hydrate_func(value)
-
- def _serialize(self, key, value):
- dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
- lambda x: x)
- return dehydrate_func(value)
-
def __str__(self):
s = six.text_type(self.__unicode__())
if not six.PY3:
self.task = task
self._load_data(data)
- def deserialize_entry(self, data):
- return datetime.datetime.strptime(data, DATE_FORMAT) if data else None
-
- def serialize_entry(self, date):
- return date.strftime(DATE_FORMAT) if date else ''
-
def remove(self):
self.task.remove_annotation(self)
def __init__(self, warrior, **kwargs):
self.warrior = warrior
+ # Check that user is not able to set read-only value in __init__
+ for key in kwargs.keys():
+ if key in self.read_only_fields:
+ raise RuntimeError('Field \'%s\' is read-only' % key)
+
# We serialize the data in kwargs so that users of the library
# do not have to pass different data formats via __setitem__ and
# __init__ methods, that would be confusing
def saved(self):
return self['uuid'] is not None or self['id'] is not None
- def serialize_due(self, date):
- if not date:
- return None
- return date.strftime(DATE_FORMAT)
-
- def deserialize_due(self, date_str):
- if not date_str:
- return None
- return datetime.datetime.strptime(date_str, DATE_FORMAT)
-
def serialize_depends(self, cur_dependencies):
# Check that all the tasks are saved
for task in cur_dependencies:
raise Task.NotSaved('Task \'%s\' needs to be saved before '
'it can be set as dependency.' % task)
- # Return the list of uuids
- return ','.join(task['uuid'] for task in cur_dependencies)
-
- def deserialize_depends(self, raw_uuids):
- raw_uuids = raw_uuids or '' # Convert None to empty string
- uuids = raw_uuids.split(',')
- return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
+ return super(Task, self).serialize_depends(cur_dependencies)
def format_depends(self):
# We need to generate added and removed dependencies list,
['-' + t['uuid'] for t in removed]
)
- def deserialize_annotations(self, data):
- return [TaskAnnotation(self, d) for d in data] if data else []
-
- def deserialize_tags(self, tags):
- if isinstance(tags, basestring):
- return tags.split(',') if tags else []
- return tags
-
- def serialize_tags(self, tags):
- return ','.join(tags) if tags else ''
-
def format_description(self):
# Task version older than 2.4.0 ignores first word of the
# task description if description: prefix is used
if self.warrior.version < VERSION_2_4_0:
return self._data['description']
else:
- return "description:{0}".format(self._data['description'] or '')
+ return "description:'{0}'".format(self._data['description'] or '')
def delete(self):
if not self.saved:
if self.deleted:
raise Task.DeletedTask("Task was already deleted")
- self.warrior.execute_command([self['uuid'], 'delete'], config_override={
- 'confirmation': 'no',
- })
+ self.warrior.execute_command([self['uuid'], 'delete'])
# Refresh the status again, so that we have updated info stored
self.refresh(only_fields=['status'])
def add_field(field):
# Add the output of format_field method to args list (defaults to
# field:value)
- format_default = lambda k: '{0}:{1}'.format(k, self._data[k] or '')
+ format_default = lambda k: "{0}:'{1}'".format(k, self._data[k] or '')
format_func = getattr(self, 'format_{0}'.format(field),
lambda: format_default(field))
args.append(format_func())
self._load_data(new_data)
-class TaskFilter(object):
+class TaskFilter(SerializingObject):
"""
A set of parameters to filter the task list with.
"""
# Replace the value with empty string, since that is the
# convention in TW for empty values
- value = value if value is not None else ''
+ attribute_key = key.split('.')[0]
+ value = self._serialize(attribute_key, value)
# If we are filtering by uuid:, do not use uuid keyword
# due to TW-1452 bug
if key == 'uuid':
self.filter_params.insert(0, value)
else:
- self.filter_params.append('{0}:{1}'.format(key, value))
+ self.filter_params.append("{0}:'{1}'".format(key, value))
def get_filter_params(self):
return [f for f in self.filter_params if f]
os.makedirs(data_location)
self.config = {
'data.location': os.path.expanduser(data_location),
+ 'confirmation': 'no',
}
self.tasks = TaskQuerySet(self)
self.version = self._get_version()
})
def undo(self):
- self.execute_command(['undo'], config_override={
- 'confirmation': 'no',
- })
+ self.execute_command(['undo'])