PENDING = 'pending'
COMPLETED = 'completed'
+VERSION_2_1_0 = six.u('2.1.0')
+VERSION_2_2_0 = six.u('2.2.0')
+VERSION_2_3_0 = six.u('2.3.0')
+VERSION_2_4_0 = six.u('2.4.0')
+
logger = logging.getLogger(__name__)
def _load_data(self, data):
self._data = data
+ # We need to use a copy for original data, so that changes
+ # are not propagated
+ self._original_data = data.copy()
def __getitem__(self, key):
+ # This is a workaround to make TaskResource non-iterable
+ # over simple index-based iteration
+ try:
+ int(key)
+ raise StopIteration
+ except ValueError:
+ pass
+
hydrate_func = getattr(self, 'deserialize_{0}'.format(key),
lambda x: x)
return hydrate_func(self._data.get(key))
dehydrate_func = getattr(self, 'serialize_{0}'.format(key),
lambda x: x)
self._data[key] = dehydrate_func(value)
- self._modified_fields.add(key)
def __str__(self):
s = six.text_type(self.__unicode__())
kwargs.update(data)
self._load_data(kwargs)
- self._modified_fields = set()
def __unicode__(self):
return self['description']
+ def __eq__(self, other):
+ return self['uuid'] == other['uuid']
+
+ def __hash__(self):
+ return self['uuid'].__hash__()
+
+ @property
+ def _modified_fields(self):
+ for key in self._data.keys():
+ if self._data.get(key) != self._original_data.get(key):
+ yield key
+
@property
def completed(self):
return self['status'] == six.text_type('completed')
def delete(self):
if not self.saved:
- raise self.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 self.DeletedTask("Task was already deleted")
+ raise Task.DeletedTask("Task was already deleted")
self.warrior.execute_command([self['uuid'], 'delete'], config_override={
'confirmation': 'no',
def done(self):
if not self.saved:
- raise self.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 self.CompletedTask("Cannot complete a completed task")
+ raise Task.CompletedTask("Cannot complete a completed task")
elif self.deleted:
- raise self.DeletedTask("Deleted task cannot be completed")
+ raise Task.DeletedTask("Deleted task cannot be completed")
self.warrior.execute_command([self['uuid'], 'done'])
# Circumvent the ID storage, since ID is considered read-only
self._data['id'] = int(id_lines[0].split(' ')[2].rstrip('.'))
- self._modified_fields.clear()
self.refresh()
def add_annotation(self, annotation):
if not self.saved:
- raise self.NotSaved("Task needs to be saved to add annotation")
+ raise Task.NotSaved("Task needs to be saved to add annotation")
args = [self['uuid'], 'annotate', annotation]
self.warrior.execute_command(args)
def remove_annotation(self, annotation):
if not self.saved:
- raise self.NotSaved("Task needs to be saved to add annotation")
+ raise Task.NotSaved("Task needs to be saved to add annotation")
if isinstance(annotation, TaskAnnotation):
annotation = annotation['description']
def _get_modified_fields_as_args(self):
args = []
+ def add_field(field):
+ # 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 and field == 'description':
+ args.append(self._data[field])
+ else:
+ args.append('{0}:{1}'.format(field, self._data[field]))
+
# If we're modifying saved task, simply pass on all modified fields
if self.saved:
for field in self._modified_fields:
- args.append('{0}:{1}'.format(field, self._data[field]))
+ add_field(field)
# For new tasks, pass all fields that make sense
else:
for field in self._data.keys():
if field in self.read_only_fields:
continue
- args.append('{0}:{1}'.format(field, self._data[field]))
+ add_field(field)
return args
def refresh(self, only_fields=[]):
# Raise error when trying to refresh a task that has not been saved
if not self.saved:
- raise self.NotSaved("Task needs to be saved to be refreshed")
+ raise Task.NotSaved("Task needs to be saved to be refreshed")
# We need to use ID as backup for uuid here for the refreshes
# of newly saved tasks. Any other place in the code is fine
to_update = dict(
[(k, new_data.get(k)) for k in only_fields])
self._data.update(to_update)
+ self._original_data.update(to_update)
else:
self._data = new_data
+ # We need to create a clone for original_data though
+ # Shallow copy is alright, since data dict uses only
+ # primitive data types
+ self._original_data = new_data.copy()
class TaskFilter(object):
# Replace the value with empty string, since that is the
# convention in TW for empty values
value = value if value is not None else ''
- self.filter_params.append('{0}:{1}'.format(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))
def get_filter_params(self):
return [f for f in self.filter_params if f]
'data.location': os.path.expanduser(data_location),
}
self.tasks = TaskQuerySet(self)
+ self.version = self._get_version()
def _get_command_args(self, args, config_override={}):
command_args = ['task', 'rc:/']
command_args.extend(map(str, args))
return command_args
+ def _get_version(self):
+ p = subprocess.Popen(
+ ['task', '--version'],
+ stdout=subprocess.PIPE,
+ stderr=subprocess.PIPE)
+ stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
+ return stdout.strip('\n')
+
def execute_command(self, args, config_override={}):
command_args = self._get_command_args(
args, config_override=config_override)
projects / etc / taskwarrior.git / blobdiff