Task: Autmoatically detect TaskWarrior instance in from_input

[etc/taskwarrior.git] / tasklib / task.py

diff --git a/tasklib/task.py b/tasklib/task.py
index ca21b2bec2caa25f6683f9d1f511ce297e7affbf..50384bfbd2805aa04362b0868d94fd9905937d0c 100644 (file)
--- a/tasklib/task.py
+++ b/tasklib/task.py
@@ -28,6 +28,37 @@ class TaskWarriorException(Exception):
     pass
 
 
     pass
 
 

+class ReadOnlyDictView(object):
+    """
+    Provides simplified read-only view upon dict object.
+    """
+
+    def __init__(self, viewed_dict):
+        self.viewed_dict = viewed_dict
+
+    def __getitem__(self, key):
+        return copy.deepcopy(self.viewed_dict.__getitem__(key))
+
+    def __contains__(self, k):
+        return self.viewed_dict.__contains__(k)
+
+    def __iter__(self):
+        for value in self.viewed_dict:
+            yield copy.deepcopy(value)
+
+    def __len__(self):
+        return len(self.viewed_dict)
+
+    def get(self, key, default=None):
+        return copy.deepcopy(self.viewed_dict.get(key, default))
+
+    def items(self):
+        return [copy.deepcopy(v) for v in self.viewed_dict.items()]
+
+    def values(self):
+        return [copy.deepcopy(v) for v in self.viewed_dict.values()]
+
+

 class SerializingObject(object):
     """
     Common ancestor for TaskResource & TaskFilter, since they both
 class SerializingObject(object):
     """
     Common ancestor for TaskResource & TaskFilter, since they both


@@ -44,6 +75,15 @@ class SerializingObject(object):
         not export empty-valued attributes) if the attribute
         is not iterable (e.g. list or set), in which case
         a empty iterable should be used.
         not export empty-valued attributes) if the attribute
         is not iterable (e.g. list or set), in which case
         a empty iterable should be used.

+
+    Normalizing methods should hold the following contract:
+      - They are used to validate and normalize the user input.
+        Any attribute value that comes from the user (during Task
+        initialization, assignign values to Task attributes, or
+        filtering by user-provided values of attributes) is first
+        validated and normalized using the normalize_{key} method.
+      - If validation or normalization fails, normalizer is expected
+        to raise ValueError.

     """
 
     def _deserialize(self, key, value):
     """
 
     def _deserialize(self, key, value):


@@ -63,6 +103,10 @@ class SerializingObject(object):
         or entered as a value of Task attribute.
         """
 
         or entered as a value of Task attribute.
         """
 

+        # None value should not be converted by normalizer
+        if value is None:
+            return None
+

         normalize_func = getattr(self, 'normalize_{0}'.format(key),
                                  lambda x: x)
 
         normalize_func = getattr(self, 'normalize_{0}'.format(key),
                                  lambda x: x)
 


@@ -93,36 +137,54 @@ class SerializingObject(object):
     def deserialize_entry(self, value):
         return self.timestamp_deserializer(value)
 
     def deserialize_entry(self, value):
         return self.timestamp_deserializer(value)
 

+    def normalize_entry(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_modified(self, value):
         return self.timestamp_serializer(value)
 
     def deserialize_modified(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 normalize_modified(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_due(self, value):
         return self.timestamp_serializer(value)
 
     def deserialize_due(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 normalize_due(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_scheduled(self, value):
         return self.timestamp_serializer(value)
 
     def deserialize_scheduled(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 normalize_scheduled(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_until(self, value):
         return self.timestamp_serializer(value)
 
     def deserialize_until(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 normalize_until(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_wait(self, value):
         return self.timestamp_serializer(value)
 
     def deserialize_wait(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 normalize_wait(self, value):
+        return self.datetime_normalizer(value)
+

     def serialize_annotations(self, value):
         value = value if value is not None else []
 
     def serialize_annotations(self, value):
         value = value if value is not None else []
 


@@ -153,7 +215,7 @@ class SerializingObject(object):
         uuids = raw_uuids.split(',')
         return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
 
         uuids = raw_uuids.split(',')
         return set(self.warrior.tasks.get(uuid=uuid) for uuid in uuids if uuid)
 

-    def normalize_datetime(self, value):
+    def datetime_normalizer(self, value):

         """
         Normalizes date/datetime value (considered to come from user input)
         to localized datetime value. Following conversions happen:
         """
         Normalizes date/datetime value (considered to come from user input)
         to localized datetime value. Following conversions happen:


@@ -175,9 +237,16 @@ class SerializingObject(object):
             # If the value is already localized, there is no need to change
             # time zone at this point. Also None is a valid value too.
             localized = value
             # If the value is already localized, there is no need to change
             # time zone at this point. Also None is a valid value too.
             localized = value

-        
+

         return localized
         return localized

-            
+
+    def normalize_uuid(self, value):
+        # Enforce sane UUID
+        if not isinstance(value, six.string_types) or value == '':
+            raise ValueError("UUID must be a valid non-empty string, "
+                             "not: {}".format(value))
+
+        return value

 
 
 class TaskResource(SerializingObject):
 
 
 class TaskResource(SerializingObject):


@@ -221,11 +290,8 @@ class TaskResource(SerializingObject):
         if key in self.read_only_fields:
             raise RuntimeError('Field \'%s\' is read-only' % key)
 
         if key in self.read_only_fields:
             raise RuntimeError('Field \'%s\' is read-only' % key)
 

-        # Localize any naive date/datetime to the detected timezone
-        if (isinstance(value, datetime.datetime) or
-            isinstance(value, datetime.date)):
-            value = self.normalize_datetime(value)
-
+        # Normalize the user input before saving it
+        value = self._normalize(key, value)

         self._data[key] = value
 
     def __str__(self):
         self._data[key] = value
 
     def __str__(self):


@@ -319,7 +385,7 @@ class Task(TaskResource):
         pass
 
     @classmethod
         pass
 
     @classmethod

-    def from_input(cls, input_file=sys.stdin, modify=None):
+    def from_input(cls, input_file=sys.stdin, modify=None, warrior=None):

         """
         Creates a Task object, directly from the stdin, by reading one line.
         If modify=True, two lines are used, first line interpreted as the
         """
         Creates a Task object, directly from the stdin, by reading one line.
         If modify=True, two lines are used, first line interpreted as the


@@ -335,13 +401,18 @@ class Task(TaskResource):
         but defaults to sys.stdin.
         """
 
         but defaults to sys.stdin.
         """
 

-        # TaskWarrior instance is set to None
-        task = cls(None)
-

         # Detect the hook type if not given directly
         name = os.path.basename(sys.argv[0])
         modify = name.startswith('on-modify') if modify is None else modify
 
         # Detect the hook type if not given directly
         name = os.path.basename(sys.argv[0])
         modify = name.startswith('on-modify') if modify is None else modify
 

+        # Create the TaskWarrior instance if none passed
+        if warrior is None:
+            hook_parent_dir = os.path.dirname(os.path.dirname(sys.argv[0]))
+            warrior = TaskWarrior(data_location=hook_parent_dir)
+
+        # TaskWarrior instance is set to None
+        task = cls(warrior)
+

         # Load the data from the input
         task._load_data(json.loads(input_file.readline().strip()))
 
         # Load the data from the input
         task._load_data(json.loads(input_file.readline().strip()))
 


@@ -369,6 +440,9 @@ class Task(TaskResource):
                           for (key, value) in six.iteritems(kwargs))
         self._original_data = copy.deepcopy(self._data)
 
                           for (key, value) in six.iteritems(kwargs))
         self._original_data = copy.deepcopy(self._data)
 

+        # Provide read only access to the original data
+        self.original = ReadOnlyDictView(self._original_data)
+

     def __unicode__(self):
         return self['description']
 
     def __unicode__(self):
         return self['description']
 


@@ -593,12 +667,8 @@ class TaskFilter(SerializingObject):
         # convention in TW for empty values
         attribute_key = key.split('.')[0]
 
         # convention in TW for empty values
         attribute_key = key.split('.')[0]
 

-        # Since this is user input, we need to normalize datetime
-        # objects
-        if (isinstance(value, datetime.datetime) or
-            isinstance(value, datetime.date)):
-            value = self.normalize_datetime(value)
-
+        # Since this is user input, we need to normalize before we serialize
+        value = self._normalize(key, value)

         value = self._serialize(attribute_key, value)
 
         # If we are filtering by uuid:, do not use uuid keyword
         value = self._serialize(attribute_key, value)
 
         # If we are filtering by uuid:, do not use uuid keyword


@@ -766,14 +836,14 @@ class TaskWarrior(object):
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         return stdout.strip('\n')
 

-    def execute_command(self, args, config_override={}):
+    def execute_command(self, args, config_override={}, allow_failure=True):

         command_args = self._get_command_args(
             args, config_override=config_override)
         logger.debug(' '.join(command_args))
         p = subprocess.Popen(command_args, stdout=subprocess.PIPE,
                              stderr=subprocess.PIPE)
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]
         command_args = self._get_command_args(
             args, config_override=config_override)
         logger.debug(' '.join(command_args))
         p = subprocess.Popen(command_args, stdout=subprocess.PIPE,
                              stderr=subprocess.PIPE)
         stdout, stderr = [x.decode('utf-8') for x in p.communicate()]

-        if p.returncode:
+        if p.returncode and allow_failure:

             if stderr.strip():
                 error_msg = stderr.strip().splitlines()[-1]
             else:
             if stderr.strip():
                 error_msg = stderr.strip().splitlines()[-1]
             else:


@@ -781,7 +851,15 @@ class TaskWarrior(object):
             raise TaskWarriorException(error_msg)
         return stdout.strip().split('\n')
 
             raise TaskWarriorException(error_msg)
         return stdout.strip().split('\n')
 

+    def enforce_recurrence(self):
+        # Run arbitrary report command which will trigger generation
+        # of recurrent tasks.
+        # TODO: Make a version dependant enforcement once
+        #       TW-1531 is handled
+        self.execute_command(['next'], allow_failure=False)
+

     def filter_tasks(self, filter_obj):
     def filter_tasks(self, filter_obj):

+        self.enforce_recurrence()

         args = ['export', '--'] + filter_obj.get_filter_params()
         tasks = []
         for line in self.execute_command(args):
         args = ['export', '--'] + filter_obj.get_filter_params()
         tasks = []
         for line in self.execute_command(args):